KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ecs > Attributes


1 /*
2  * ====================================================================
3  *
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 1999-2003 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if
22  * any, must include the following acknowlegement:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "The Jakarta Project", "Jakarta Element Construction Set",
29  * "Jakarta ECS" , and "Apache Software Foundation" must not be used
30  * to endorse or promote products derived
31  * from this software without prior written permission. For written
32  * permission, please contact apache@apache.org.
33  *
34  * 5. Products derived from this software may not be called "Apache",
35  * "Jakarta Element Construction Set" nor "Jakarta ECS" nor may "Apache"
36  * appear in their names without prior written permission of the Apache Group.
37  *
38  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
39  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
40  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
41  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
42  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
44  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
45  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
46  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
47  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
48  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
49  * SUCH DAMAGE.
50  * ====================================================================
51  *
52  * This software consists of voluntary contributions made by many
53  * individuals on behalf of the Apache Software Foundation. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  *
57  */
58 package org.apache.ecs;
59
60 /**
61     This interface describes the attributes within an element. It is
62     implemented by ElementAttributes.
63
64     @version $Id: Attributes.java,v 1.5 2003/04/27 09:44:39 rdonkin Exp $
65     @author <a HREF="mailto:snagy@servletapi.com">Stephan Nagy</a>
66     @author <a HREF="mailto:jon@clearink.com">Jon S. Stevens</a>
67 */
68 public interface Attributes
69 {
70     /**
71         Does this element attribute value need a =""?
72     */
73     public static final String JavaDoc NO_ATTRIBUTE_VALUE = "ECS_NO_ATTRIBUTE_VALUE";
74
75     /**
76         Set the state of the attribute filter.
77         @param filter_attribute_state do we need to filter attributes?
78     */
79     public Element setAttributeFilterState(boolean filter_attribute_state);
80
81     /**
82         Set the AttributeFilter that should be used.
83         @param attribute_filter set the attribute filter to be used.
84     */
85     public Element setAttributeFilter(Filter attribute_filter);
86
87     /**
88         Get the AttributeFilter that is in use.
89     */
90     public Filter getAttributeFilter();
91
92     /**
93         Add an attribute to the Element.
94         @param name name of the attribute
95         @param element value of the attribute.
96     */
97     public Element addAttribute(String JavaDoc name,Object JavaDoc element);
98
99     /**
100         Add an attribute to the Element.
101         @param name name of the attribute
102         @param element value of the attribute.
103     */
104     public Element addAttribute(String JavaDoc name, int element);
105
106     /**
107         Add an attribute to the Element.
108         @param name name of the attribute
109         @param element value of the attribute.
110     */
111     public Element addAttribute(String JavaDoc name, String JavaDoc element);
112
113     /**
114         Add an attribute to the Element.
115         @param name name of the attribute
116         @param element value of the attribute.
117     */
118     public Element addAttribute(String JavaDoc name, Integer JavaDoc element);
119     
120     /**
121         Remove an attribute from the element.
122         @param name remove the attribute of this name
123     */
124     public Element removeAttribute(String JavaDoc name);
125
126     /**
127         Does the element have an attribute.
128         @param name of the attribute to ask the element for.
129     */
130     public boolean hasAttribute(String JavaDoc name);
131
132     /**
133         Set the character used to quote attributes.
134         @param quote_char character used to quote attributes
135     */
136     public Element setAttributeQuoteChar(char quote_char);
137
138     /**
139         Get the character used to quote attributes.
140     */
141     public char getAttributeQuoteChar();
142
143     /**
144         Set the equality sign for an attribute.
145         @param equality_sign The equality sign used for attributes.
146     */
147     public Element setAttributeEqualitySign(char equality_sign);
148
149     /**
150         Get the equality sign for an attribute.
151     */
152     public char getAttributeEqualitySign();
153
154     /**
155         Do we surround attributes with qoutes?
156     */
157     public boolean getAttributeQuote();
158
159     /**
160         Set wether or not we surround the attributes with quotes.
161     */
162     public Element setAttributeQuote(boolean attribute_quote);
163 }
164
Popular Tags