Package org.simpleframework.xml.stream
Class EventAttribute
java.lang.Object
org.simpleframework.xml.stream.EventAttribute
- All Implemented Interfaces:
Attribute
- Direct Known Subclasses:
DocumentReader.Entry
,PullReader.Entry
,StreamReader.Entry
The
EventAttribute
object represents an attribute
that is associated with an event node. An attribute is required
to provide the name and value for the attribute, and optionally
the namespace reference and prefix. For debugging purposes the
source object from the internal XML provider can be acquired.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThis is used to acquire the namespace prefix associated with this attribute.This is used to acquire the namespace reference that this attribute is in.This is used to return the source of the attribute.boolean
This returns true if the attribute is reserved.
-
Constructor Details
-
EventAttribute
EventAttribute()
-
-
Method Details
-
getPrefix
This is used to acquire the namespace prefix associated with this attribute. A prefix is used to qualify the attribute within a namespace. So, if this has a prefix then it should have a reference associated with it. -
getReference
This is used to acquire the namespace reference that this attribute is in. A namespace is normally associated with an attribute if that attribute is prefixed with a known token. If there is no prefix then this will return null.- Specified by:
getReference
in interfaceAttribute
- Returns:
- this provides the associated namespace reference
-
getSource
This is used to return the source of the attribute. Depending on which provider was selected to parse the XML document an object for the internal parsers representation of this will be returned. This is useful for debugging purposes. -
isReserved
public boolean isReserved()This returns true if the attribute is reserved. An attribute is considered reserved if it begins with "xml" according to the namespaces in XML 1.0 specification. Such attributes are used for namespaces and other such details.- Specified by:
isReserved
in interfaceAttribute
- Returns:
- this returns true if the attribute is reserved
-