com.envoisolutions.sxc.util
Interface Attribute

All Known Implementing Classes:
XoXMLStreamReaderImpl.AttributeImpl

public interface Attribute

Attribute provides access to the current attribute of the getAttributes iterator on of XoXMLStreamReader.

CAUTION: For performance reasons, the the same attribute object instance is used for all iterations with only the internal state of the attribute object changed for each iteration. Therefore, you must be careful to not retain the Attribute insance after calling next() on the iterator.


Method Summary
 boolean getBooleanValue()
           
 byte getByteValue()
           
 double getDoubleValue()
           
 float getFloatValue()
           
 int getIndex()
          Returns the index of the current attribute in the XoXMLStreamREader.
 int getIntValue()
           
 java.lang.String getLocalName()
          Returns the local name of the current attribute.
 long getLongValue()
           
 javax.xml.namespace.QName getName()
          Returns the QName of the current attribute.
 java.lang.String getNamespace()
          Returns the namespace of the current attribute.
 java.lang.String getPrefix()
          Returns the namespace prefix of the current attribute.
 XoXMLStreamReader getReader()
          Returns the XoXMLStreamReader;
 short getShortValue()
           
 java.lang.String getType()
          Returns the type of the current attribute.
 java.lang.String getValue()
          Returns the value of the current attribute.
 java.lang.Iterable<java.lang.String> getXmlListValue()
           
 

Method Detail

getName

javax.xml.namespace.QName getName()
Returns the QName of the current attribute.

Returns:
the QName of the current attribute
Throws:
java.lang.IllegalStateException - if the XoXMLStreamReader is not in START_ELEMENT or ATTRIBUTE state

getLocalName

java.lang.String getLocalName()
Returns the local name of the current attribute.

Returns:
the local name of the current attribute
Throws:
java.lang.IllegalStateException - if the XoXMLStreamReader is not in START_ELEMENT or ATTRIBUTE state

getNamespace

java.lang.String getNamespace()
Returns the namespace of the current attribute.

Returns:
the namespace of the current attribute
Throws:
java.lang.IllegalStateException - if the XoXMLStreamReader is not in START_ELEMENT or ATTRIBUTE state

getPrefix

java.lang.String getPrefix()
Returns the namespace prefix of the current attribute.

Returns:
the namespace prefix of the current attribute
Throws:
java.lang.IllegalStateException - if the XoXMLStreamReader is not in START_ELEMENT or ATTRIBUTE state

getType

java.lang.String getType()
Returns the type of the current attribute.

Returns:
the type of the current attribute
Throws:
java.lang.IllegalStateException - if the XoXMLStreamReader is not in START_ELEMENT or ATTRIBUTE state

getValue

java.lang.String getValue()
Returns the value of the current attribute.

Returns:
the value of the current attribute
Throws:
java.lang.IllegalStateException - if the XoXMLStreamReader is not in START_ELEMENT or ATTRIBUTE state

getBooleanValue

boolean getBooleanValue()

getByteValue

byte getByteValue()

getShortValue

short getShortValue()

getIntValue

int getIntValue()

getLongValue

long getLongValue()

getFloatValue

float getFloatValue()

getDoubleValue

double getDoubleValue()

getXmlListValue

java.lang.Iterable<java.lang.String> getXmlListValue()

getIndex

int getIndex()
Returns the index of the current attribute in the XoXMLStreamREader.

Returns:
the index of the current attribute

getReader

XoXMLStreamReader getReader()
Returns the XoXMLStreamReader;

Returns:
the XoXMLStreamReader


Copyright © 2007-2008 Envoi Solutions LLC. All Rights Reserved.