Package org.simpleframework.xml.stream
Class PullReader.Entry
java.lang.Object
org.simpleframework.xml.stream.EventAttribute
org.simpleframework.xml.stream.PullReader.Entry
- All Implemented Interfaces:
Attribute
- Enclosing class:
PullReader
The
Entry
object is used to represent an attribute
within a start element. This holds the name and value of the
attribute as well as the namespace prefix and reference. These
details can be used to represent the attribute so that should
the core reader require these details they can be acquired.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final String
This is the name that is used by this attribute.private final String
This is the XML namespace prefix used by the attribute.private final String
This is the XML namespace reference used by the attribute.private final org.xmlpull.v1.XmlPullParser
This is the XML pull parser source that is used for this.private final String
This is the value that is used by this attribute. -
Constructor Summary
ConstructorsConstructorDescriptionEntry
(org.xmlpull.v1.XmlPullParser source, int index) Constructor for theEntry
object. -
Method Summary
Modifier and TypeMethodDescriptiongetName()
This provides the name of the attribute.This 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 node for the attribute.getValue()
This returns the value of the event.boolean
This returns true if the attribute is reserved.
-
Field Details
-
source
private final org.xmlpull.v1.XmlPullParser sourceThis is the XML pull parser source that is used for this. -
reference
This is the XML namespace reference used by the attribute. -
prefix
This is the XML namespace prefix used by the attribute. -
name
This is the name that is used by this attribute. -
value
This is the value that is used by this attribute.
-
-
Constructor Details
-
Entry
public Entry(org.xmlpull.v1.XmlPullParser source, int index) Constructor for theEntry
object. This creates an attribute object that is used to extract the name, value namespace prefix, and namespace reference from the provided node. This is used to populate any start events created.- Parameters:
source
- this is the parser used to get the attributeindex
- this is the index of the attribute to get
-
-
Method Details
-
getName
This provides the name of the attribute. This will be the name of the XML attribute without any namespace prefix. If the name begins with "xml" then this attribute is reserved. according to the namespaces for XML 1.0 specification.- Returns:
- this returns the name of this attribute object
-
getValue
This returns the value of the event. This will be the value that the attribute contains. If the attribute does not have a value then this returns null or an empty string.- Returns:
- this returns the value represented by this object
-
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
- Overrides:
isReserved
in classEventAttribute
- Returns:
- this returns true if the attribute is reserved
-
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
- Overrides:
getReference
in classEventAttribute
- Returns:
- this provides the associated namespace reference
-
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.- Specified by:
getPrefix
in interfaceAttribute
- Overrides:
getPrefix
in classEventAttribute
- Returns:
- this returns the namespace prefix for the attribute
-
getSource
This is used to return the node for the attribute. Because this represents an XML event the XML parser is returned. Returning the node helps with certain debugging issues.- Specified by:
getSource
in interfaceAttribute
- Overrides:
getSource
in classEventAttribute
- Returns:
- this will return the source object for this
-