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