001: /**
002: * Redistribution and use of this software and associated documentation
003: * ("Software"), with or without modification, are permitted provided
004: * that the following conditions are met:
005: *
006: * 1. Redistributions of source code must retain copyright
007: * statements and notices. Redistributions must also contain a
008: * copy of this document.
009: *
010: * 2. Redistributions in binary form must reproduce the
011: * above copyright notice, this list of conditions and the
012: * following disclaimer in the documentation and/or other
013: * materials provided with the distribution.
014: *
015: * 3. The name "Exolab" must not be used to endorse or promote
016: * products derived from this Software without prior written
017: * permission of Intalio, Inc. For written permission,
018: * please contact info@exolab.org.
019: *
020: * 4. Products derived from this Software may not be called "Exolab"
021: * nor may "Exolab" appear in their names without prior written
022: * permission of Intalio, Inc. Exolab is a registered
023: * trademark of Intalio, Inc.
024: *
025: * 5. Due credit should be given to the Exolab Project
026: * (http://www.exolab.org/).
027: *
028: * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
029: * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
030: * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
031: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
032: * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
033: * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
034: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
035: * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
036: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
037: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
038: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
039: * OF THE POSSIBILITY OF SUCH DAMAGE.
040: *
041: * Copyright 2001-2002 (C) Intalio, Inc. All Rights Reserved.
042: *
043: * $Id: AttributeSet.java 5951 2006-05-30 22:18:48Z bsnyder $
044: */package org.exolab.castor.xml;
045:
046: /**
047: * A simple interface for handling Attributes in the Marshalling
048: * Framework.
049: *
050: * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
051: * @version $Revision: 5951 $ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
052: **/
053: public interface AttributeSet {
054:
055: /**
056: * Returns the index of the attribute associated with the given name
057: * and namespace.
058: *
059: *
060: * @param name the name of the attribute whose value should be returned.
061: * @param namespace the namespace of the attribute
062: * @return the index of the attribute, or -1 if not found.
063: **/
064: public int getIndex(String name, String namespace);
065:
066: /**
067: * Returns the name of the attribute located at the given index.
068: *
069: * @param index the index of the attribute whose name should be returned.
070: * @return the name of the attribute located at the given index.
071: **/
072: public String getName(int index);
073:
074: /**
075: * Returns the namespace of the attribute located at the given index.
076: *
077: * @return the namespace of the attribute located at the given index.
078: **/
079: public String getNamespace(int index);
080:
081: /**
082: * Returns the number of Attributes within this AttributeSet.
083: *
084: * @return the number of Attributes within this AttributeSet.
085: **/
086: public int getSize();
087:
088: /**
089: * Returns the value of the attribute located at the given index
090: * within this AttributeSet.
091: *
092: * @param index the index of the attribute whose value should be returned.
093: **/
094: public String getValue(int index);
095:
096: /**
097: * Returns the value of the attribute associated with the given name.
098: * This method is equivalent to call #getValue(name, null);
099: *
100: * @param name the name of the attribute whose value should be returned.
101: **/
102: public String getValue(String name);
103:
104: /**
105: * Returns the value of the attribute associated with the given name.
106: * This method is equivalent to call #getValue(name, null);
107: *
108: * @param name the name of the attribute whose value should be returned.
109: * @param namespace the namespace of the attribute
110: **/
111: public String getValue(String name, String namespace);
112:
113: } //-- AttributeSet
|