1 /**
2 * Redistribution and use of this software and associated documentation ("Software"), with or
3 * without modification, are permitted provided that the following conditions are met:
4 *
5 * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
6 * must also contain a copy of this document.
7 *
8 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
9 * conditions and the following disclaimer in the documentation and/or other materials provided with
10 * the distribution.
11 *
12 * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
13 * without prior written permission of Intalio, Inc. For written permission, please contact
14 * info@exolab.org.
15 *
16 * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
17 * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
18 * Intalio, Inc.
19 *
20 * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
21 *
22 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
24 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
25 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
29 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 *
31 * Copyright 2001-2002 (C) Intalio, Inc. All Rights Reserved.
32 *
33 * $Id$
34 */
35
36 package org.exolab.castor.xml;
37
38 /**
39 * A simple interface for handling Attributes in the Marshalling Framework.
40 *
41 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
42 * @version $Revision$ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
43 **/
44 public interface AttributeSet {
45
46
47 /**
48 * Returns the index of the attribute associated with the given name and namespace.
49 *
50 *
51 * @param name the name of the attribute whose value should be returned.
52 * @param namespace the namespace of the attribute
53 * @return the index of the attribute, or -1 if not found.
54 **/
55 public int getIndex(String name, String namespace);
56
57 /**
58 * Returns the name of the attribute located at the given index.
59 *
60 * @param index the index of the attribute whose name should be returned.
61 * @return the name of the attribute located at the given index.
62 **/
63 public String getName(int index);
64
65 /**
66 * Returns the namespace of the attribute located at the given index.
67 *
68 * @return the namespace of the attribute located at the given index.
69 **/
70 public String getNamespace(int index);
71
72 /**
73 * Returns the number of Attributes within this AttributeSet.
74 *
75 * @return the number of Attributes within this AttributeSet.
76 **/
77 public int getSize();
78
79 /**
80 * Returns the value of the attribute located at the given index within this AttributeSet.
81 *
82 * @param index the index of the attribute whose value should be returned.
83 **/
84 public String getValue(int index);
85
86 /**
87 * Returns the value of the attribute associated with the given name. This method is equivalent to
88 * call #getValue(name, null);
89 *
90 * @param name the name of the attribute whose value should be returned.
91 **/
92 public String getValue(String name);
93
94 /**
95 * Returns the value of the attribute associated with the given name. This method is equivalent to
96 * call #getValue(name, null);
97 *
98 * @param name the name of the attribute whose value should be returned.
99 * @param namespace the namespace of the attribute
100 **/
101 public String getValue(String name, String namespace);
102
103 } // -- AttributeSet
104
105