|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.jdom.Attribute
Attribute
defines behavior for an XML
attribute, modeled in Java. Methods allow the user
to obtain the value of the attribute as well as
namespace information.
Field Summary | |
static int |
CDATA_ATTRIBUTE
Attribute type: the attribute value is a string. |
static int |
ENTITIES_ATTRIBUTE
Attribute type: the attribute value is a list of entity names. |
static int |
ENTITY_ATTRIBUTE
Attribute type: the attribute value is the name of an entity. |
static int |
ENUMERATED_ATTRIBUTE
Attribute type: the attribute value is a name token from an enumeration. |
static int |
ID_ATTRIBUTE
Attribute type: the attribute value is a unique identifier. |
static int |
IDREF_ATTRIBUTE
Attribute type: the attribute value is a reference to a unique identifier. |
static int |
IDREFS_ATTRIBUTE
Attribute type: the attribute value is a list of references to unique identifiers. |
protected java.lang.String |
name
The local name of the Attribute |
protected Namespace |
namespace
The of the Attribute |
static int |
NMTOKEN_ATTRIBUTE
Attribute type: the attribute value is a name token. |
static int |
NMTOKENS_ATTRIBUTE
Attribute type: the attribute value is a list of name tokens. |
static int |
NOTATION_ATTRIBUTE
Attribute type: the attribute value is the name of a notation. |
protected java.lang.Object |
parent
Parent element, or null if none |
protected int |
type
The type of the Attribute |
static int |
UNDECLARED_ATTRIBUTE
Attribute type: the attribute has not been declared or type is unknown. |
protected java.lang.String |
value
The value of the Attribute |
Constructor Summary | |
protected |
Attribute()
Default, no-args constructor for implementations to use if needed. |
|
Attribute(java.lang.String name,
java.lang.String value)
This will create a new Attribute with the
specified (local) name and value, and does not place
the attribute in a . |
|
Attribute(java.lang.String name,
java.lang.String value,
int type)
This will create a new Attribute with the
specified (local) name, value and type, and does not place
the attribute in a . |
|
Attribute(java.lang.String name,
java.lang.String value,
int type,
Namespace namespace)
This will create a new Attribute with the
specified (local) name, value, and type, and in the provided
. |
|
Attribute(java.lang.String name,
java.lang.String value,
Namespace namespace)
This will create a new Attribute with the
specified (local) name and value, and in the provided
. |
Method Summary | |
java.lang.Object |
clone()
This will return a clone of this Attribute . |
Attribute |
detach()
This detaches the Attribute from its parent, or does
nothing if the Attribute has no parent. |
boolean |
equals(java.lang.Object ob)
This tests for equality of this Attribute to the supplied
Object . |
int |
getAttributeType()
This will return the actual declared type of this Attribute . |
boolean |
getBooleanValue()
This gets the value of the attribute, in boolean form, and if no conversion
can occur, throws a
|
Document |
getDocument()
This retrieves the owning for
this Attribute, or null if not a currently a member of a
. |
double |
getDoubleValue()
This gets the value of the attribute, in double form, and if no conversion
can occur, throws a
|
float |
getFloatValue()
This gets the value of the attribute, in float form, and if no conversion
can occur, throws a
|
int |
getIntValue()
This gets the value of the attribute, in int form, and if no conversion
can occur, throws a
|
long |
getLongValue()
This gets the value of the attribute, in long form, and if no conversion
can occur, throws a
|
java.lang.String |
getName()
This will retrieve the local name of the Attribute . |
Namespace |
getNamespace()
This will return this Attribute 's
. |
java.lang.String |
getNamespacePrefix()
This will retrieve the namespace prefix of the Attribute . |
java.lang.String |
getNamespaceURI()
This returns the URI mapped to this Attribute 's
prefix. |
Element |
getParent()
This will return the parent of this Attribute . |
java.lang.String |
getQualifiedName()
This will retrieve the qualified name of the Attribute . |
java.lang.String |
getValue()
This will return the actual textual value of this Attribute . |
int |
hashCode()
This returns the hash code for this Attribute . |
Attribute |
setAttributeType(int type)
This will set the type of the Attribute . |
Attribute |
setName(java.lang.String name)
This sets the local name of the Attribute . |
Attribute |
setNamespace(Namespace namespace)
This sets this Attribute 's . |
protected Attribute |
setParent(Element parent)
This will set the parent of this Attribute . |
Attribute |
setValue(java.lang.String value)
This will set the value of the Attribute . |
java.lang.String |
toString()
This returns a String representation of the
Attribute , suitable for debugging. |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int UNDECLARED_ATTRIBUTE
Attribute type: the attribute has not been declared or type is unknown.
getAttributeType()
public static final int CDATA_ATTRIBUTE
Attribute type: the attribute value is a string.
getAttributeType()
public static final int ID_ATTRIBUTE
Attribute type: the attribute value is a unique identifier.
getAttributeType()
public static final int IDREF_ATTRIBUTE
Attribute type: the attribute value is a reference to a unique identifier.
getAttributeType()
public static final int IDREFS_ATTRIBUTE
Attribute type: the attribute value is a list of references to unique identifiers.
getAttributeType()
public static final int ENTITY_ATTRIBUTE
Attribute type: the attribute value is the name of an entity.
getAttributeType()
public static final int ENTITIES_ATTRIBUTE
Attribute type: the attribute value is a list of entity names.
getAttributeType()
public static final int NMTOKEN_ATTRIBUTE
Attribute type: the attribute value is a name token.
According to SAX 2.0 specification, attributes of enumerated
types should be reported as "NMTOKEN" by SAX parsers. But the
major parsers (Xerces and Crimson) provide specific values
that permit to recognize them as ENUMERATED_ATTRIBUTE
.
getAttributeType()
public static final int NMTOKENS_ATTRIBUTE
Attribute type: the attribute value is a list of name tokens.
getAttributeType()
public static final int NOTATION_ATTRIBUTE
Attribute type: the attribute value is the name of a notation.
getAttributeType()
public static final int ENUMERATED_ATTRIBUTE
Attribute type: the attribute value is a name token from an enumeration.
getAttributeType()
protected java.lang.String name
Attribute
protected transient Namespace namespace
Namespace
of the Attribute
protected java.lang.String value
Attribute
protected int type
Attribute
protected java.lang.Object parent
Constructor Detail |
protected Attribute()
Default, no-args constructor for implementations to use if needed.
public Attribute(java.lang.String name, java.lang.String value, Namespace namespace)
This will create a new Attribute
with the
specified (local) name and value, and in the provided
.
Namespace
name
- String
name of Attribute
.value
- String
value for new attribute.namespace
- Namespace
namespace for new attribute.public Attribute(java.lang.String name, java.lang.String value, int type, Namespace namespace)
This will create a new Attribute
with the
specified (local) name, value, and type, and in the provided
.
Namespace
name
- String
name of Attribute
.value
- String
value for new attribute.type
- int
type for new attribute.namespace
- Namespace
namespace for new attribute.public Attribute(java.lang.String name, java.lang.String value)
This will create a new Attribute
with the
specified (local) name and value, and does not place
the attribute in a
.
Namespace
Note: This actually explicitly puts the
Attribute
in the "empty" Namespace
(
).
Namespace.NO_NAMESPACE
name
- String
name of Attribute
.value
- String
value for new attribute.public Attribute(java.lang.String name, java.lang.String value, int type)
This will create a new Attribute
with the
specified (local) name, value and type, and does not place
the attribute in a
.
Namespace
Note: This actually explicitly puts the
Attribute
in the "empty" Namespace
(
).
Namespace.NO_NAMESPACE
name
- String
name of Attribute
.value
- String
value for new attribute.type
- int
type for new attribute.Method Detail |
public Element getParent()
This will return the parent of this Attribute
.
If there is no parent, then this returns null
.
Attribute
public Document getDocument()
This retrieves the owning
for
this Attribute, or null if not a currently a member of a
Document
.
Document
Document
owning this Attribute, or null.protected Attribute setParent(Element parent)
This will set the parent of this Attribute
.
parent
- Element
to be new parent.Attribute
modified.public Attribute detach()
This detaches the Attribute
from its parent, or does
nothing if the Attribute
has no parent.
Attribute
- this Attribute
modified.public java.lang.String getName()
This will retrieve the local name of the
Attribute
. For any XML attribute
which appears as
[namespacePrefix]:[attributeName]
,
the local name of the attribute would be
[attributeName]
. When the attribute
has no namespace, the local name is simply the attribute
name.
To obtain the namespace prefix for this
attribute, the
method should be used.
getNamespacePrefix()
String
- name of this attribute,
without any namespace prefix.public Attribute setName(java.lang.String name)
This sets the local name of the Attribute
.
Attribute
- the attribute modified.IllegalNameException
- if the given name is illegal as an
attribute name.public java.lang.String getQualifiedName()
This will retrieve the qualified name of the Attribute
.
For any XML attribute whose name is
[namespacePrefix]:[elementName]
,
the qualified name of the attribute would be
everything (both namespace prefix and
element name). When the attribute has no
namespace, the qualified name is simply the attribute's
local name.
To obtain the local name of the attribute, the
method should be used.
getName()
To obtain the namespace prefix for this attribute,
the
method should be used.
getNamespacePrefix()
String
- full name for this element.public java.lang.String getNamespacePrefix()
This will retrieve the namespace prefix of the
Attribute
. For any XML attribute
which appears as
[namespacePrefix]:[attributeName]
,
the namespace prefix of the attribute would be
[namespacePrefix]
. When the attribute
has no namespace, an empty String
is returned.
String
- namespace prefix of this
attribute.public java.lang.String getNamespaceURI()
This returns the URI mapped to this Attribute
's
prefix. If no
mapping is found, an empty String
is returned.
String
- namespace URI for this Attribute
.public Namespace getNamespace()
This will return this Attribute
's
.
Namespace
Namespace
- Namespace object for this Attribute
public Attribute setNamespace(Namespace namespace)
This sets this Attribute
's
.
If the provided namespace is null, the attribute will have no namespace.
The namespace must have a prefix.
Namespace
Element
- the element modified.IllegalNameException
- if the new namespace is the default
namespace. Attributes cannot be in a default namespace.public java.lang.String getValue()
This will return the actual textual value of this
Attribute
. This will include all text
within the quotation marks.
String
- value for this attribute.public Attribute setValue(java.lang.String value)
This will set the value of the Attribute
.
value
- String
value for the attribute.Attribute
- this Attribute modified.IllegalDataException
- if the given attribute value is
illegal character data (as determined by
Verifier.checkCharacterData(java.lang.String)
).public int getAttributeType()
This will return the actual declared type of this
Attribute
.
int
- type for this attribute.public Attribute setAttributeType(int type)
This will set the type of the Attribute
.
type
- int
type for the attribute.Attribute
- this Attribute modified.IllegalDataException
- if the given attribute type is
not one of the supported types.public java.lang.String toString()
This returns a String
representation of the
Attribute
, suitable for debugging.
toString
in class java.lang.Object
String
- information about the
Attribute
public final boolean equals(java.lang.Object ob)
This tests for equality of this Attribute
to the supplied
Object
.
equals
in class java.lang.Object
ob
- Object
to compare to.boolean
- whether the Attribute
is
equal to the supplied Object
.public final int hashCode()
This returns the hash code for this Attribute
.
hashCode
in class java.lang.Object
int
- hash code.public java.lang.Object clone()
This will return a clone of this Attribute
.
clone
in class java.lang.Object
Object
- clone of this Attribute
.public int getIntValue() throws DataConversionException
This gets the value of the attribute, in
int
form, and if no conversion
can occur, throws a
DataConversionException
int
value of attribute.DataConversionException
- when conversion fails.public long getLongValue() throws DataConversionException
This gets the value of the attribute, in
long
form, and if no conversion
can occur, throws a
DataConversionException
long
value of attribute.DataConversionException
- when conversion fails.public float getFloatValue() throws DataConversionException
This gets the value of the attribute, in
float
form, and if no conversion
can occur, throws a
DataConversionException
float
value of attribute.DataConversionException
- when conversion fails.public double getDoubleValue() throws DataConversionException
This gets the value of the attribute, in
double
form, and if no conversion
can occur, throws a
DataConversionException
double
value of attribute.DataConversionException
- when conversion fails.public boolean getBooleanValue() throws DataConversionException
This gets the value of the attribute, in
boolean
form, and if no conversion
can occur, throws a
DataConversionException
boolean
value of attribute.DataConversionException
- when conversion fails.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |