org.jdom
public class Attribute extends Object implements Serializable, Cloneable
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.
Version: $Revision: 1.40 $, $Date: 2002/03/19 04:25:37 $
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 | IDREFS_ATTRIBUTE Attribute type: the attribute value is a list of references to unique identifiers. |
static int | IDREF_ATTRIBUTE Attribute type: the attribute value is a reference to a unique identifier. |
static int | ID_ATTRIBUTE Attribute type: the attribute value is a unique identifier. |
protected String | name The local name of the Attribute |
protected Namespace | namespace The Namespace of the Attribute |
static int | NMTOKENS_ATTRIBUTE Attribute type: the attribute value is a list of name tokens. |
static int | NMTOKEN_ATTRIBUTE Attribute type: the attribute value is a name token. |
static int | NOTATION_ATTRIBUTE Attribute type: the attribute value is the name of a notation. |
protected 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 String | value The value of the Attribute |
Constructor Summary | |
---|---|
protected | Attribute() Default, no-args constructor for implementations to use if needed. |
Attribute(String name, String value, Namespace namespace)
This will create a new | |
Attribute(String name, String value, int type, Namespace namespace)
This will create a new | |
Attribute(String name, String value)
This will create a new | |
Attribute(String name, String value, int type)
This will create a new |
Method Summary | |
---|---|
Object | clone()
This will return a clone of this |
Attribute | detach()
This detaches the |
boolean | equals(Object ob)
This tests for equality of this |
int | getAttributeType()
This will return the actual declared type of this
|
boolean | getBooleanValue()
This gets the value of the attribute, in
|
Document | getDocument() |
double | getDoubleValue()
This gets the value of the attribute, in
|
float | getFloatValue()
This gets the value of the attribute, in
|
int | getIntValue()
This gets the value of the attribute, in
|
long | getLongValue()
This gets the value of the attribute, in
|
String | getName()
This will retrieve the local name of the
|
Namespace | getNamespace()
This will return this |
String | getNamespacePrefix()
This will retrieve the namespace prefix of the
|
String | getNamespaceURI()
This returns the URI mapped to this |
Element | getParent()
This will return the parent of this |
String | getQualifiedName()
This will retrieve the qualified name of the |
String | getValue()
This will return the actual textual value of this
|
int | hashCode()
This returns the hash code for this |
Attribute | setAttributeType(int type)
This will set the type of the |
Attribute | setName(String name)
This sets the local name of the |
Attribute | setNamespace(Namespace namespace)
This sets this |
protected Attribute | setParent(Element parent)
This will set the parent of this |
Attribute | setValue(String value)
This will set the value of the |
String | toString()
This returns a |
Attribute type: the attribute value is a string.
See Also: Attribute
Attribute type: the attribute value is a list of entity names.
See Also: Attribute
Attribute type: the attribute value is the name of an entity.
See Also: Attribute
Attribute type: the attribute value is a name token from an enumeration.
See Also: Attribute
Attribute type: the attribute value is a list of references to unique identifiers.
See Also: Attribute
Attribute type: the attribute value is a reference to a unique identifier.
See Also: Attribute
Attribute type: the attribute value is a unique identifier.
See Also: Attribute
Attribute
Namespace
of the Attribute
Attribute type: the attribute value is a list of name tokens.
See Also: 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.
See Also: Attribute
Attribute type: the attribute value is the name of a notation.
See Also: Attribute
Attribute
Attribute type: the attribute has not been declared or type is unknown.
See Also: Attribute
Attribute
Default, no-args constructor for implementations to use if needed.
This will create a new Attribute
with the
specified (local) name and value, and in the provided
Namespace
.
Parameters: name String
name of Attribute
. value String
value for new attribute. namespace Namespace
namespace for new attribute.
This will create a new Attribute
with the
specified (local) name, value, and type, and in the provided
Namespace
.
Parameters: name String
name of Attribute
. value String
value for new attribute. type int
type for new attribute. namespace Namespace
namespace for new attribute.
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
(NO_NAMESPACE
).
Parameters: name String
name of Attribute
. value String
value for new attribute.
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
(NO_NAMESPACE
).
Parameters: name String
name of Attribute
. value String
value for new attribute. type int
type for new attribute.
This will return a clone of this Attribute
.
Returns: Object
- clone of this Attribute
.
This detaches the Attribute
from its parent, or does
nothing if the Attribute
has no parent.
Returns: Attribute
- this Attribute
modified.
This tests for equality of this Attribute
to the supplied
Object
.
Parameters: ob Object
to compare to.
Returns: boolean
- whether the Attribute
is
equal to the supplied Object
.
This will return the actual declared type of this
Attribute
.
Returns: int
- type for this attribute.
This gets the value of the attribute, in
boolean
form, and if no conversion
can occur, throws a
DataConversionException
Returns: boolean
value of attribute.
Throws: DataConversionException when conversion fails.
This retrieves the owning Document
for
this Attribute, or null if not a currently a member of a
Document
.
Returns: Document
owning this Attribute, or null.
This gets the value of the attribute, in
double
form, and if no conversion
can occur, throws a
DataConversionException
Returns: double
value of attribute.
Throws: DataConversionException when conversion fails.
This gets the value of the attribute, in
float
form, and if no conversion
can occur, throws a
DataConversionException
Returns: float
value of attribute.
Throws: DataConversionException when conversion fails.
This gets the value of the attribute, in
int
form, and if no conversion
can occur, throws a
DataConversionException
Returns: int
value of attribute.
Throws: DataConversionException when conversion fails.
This gets the value of the attribute, in
long
form, and if no conversion
can occur, throws a
DataConversionException
Returns: long
value of attribute.
Throws: DataConversionException when conversion fails.
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
getNamespacePrefix
method should be used.
Returns: String
- name of this attribute,
without any namespace prefix.
This will return this Attribute
's
Namespace
.
Returns: Namespace
- Namespace object for this Attribute
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.
Returns: String
- namespace prefix of this
attribute.
This returns the URI mapped to this Attribute
's
prefix. If no
mapping is found, an empty String
is returned.
Returns: String
- namespace URI for this Attribute
.
This will return the parent of this Attribute
.
If there is no parent, then this returns null
.
Returns: parent of this Attribute
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
getName
method should be used.
To obtain the namespace prefix for this attribute,
the getNamespacePrefix
method should be used.
Returns: String
- full name for this element.
This will return the actual textual value of this
Attribute
. This will include all text
within the quotation marks.
Returns: String
- value for this attribute.
This returns the hash code for this Attribute
.
Returns: int
- hash code.
This will set the type of the Attribute
.
Parameters: type int
type for the attribute.
Returns: Attribute
- this Attribute modified.
Throws: IllegalDataException if the given attribute type is not one of the supported types.
This sets the local name of the Attribute
.
Returns: Attribute
- the attribute modified.
Throws: IllegalNameException if the given name is illegal as an attribute name.
This sets this Attribute
's Namespace
.
If the provided namespace is null, the attribute will have no namespace.
The namespace must have a prefix.
Returns: Element
- the element modified.
Throws: IllegalNameException if the new namespace is the default namespace. Attributes cannot be in a default namespace.
This will set the parent of this Attribute
.
Parameters: parent Element
to be new parent.
Returns: this Attribute
modified.
This will set the value of the Attribute
.
Parameters: value String
value for the attribute.
Returns: Attribute
- this Attribute modified.
Throws: IllegalDataException if the given attribute value is illegal character data (as determined by Verifier).
This returns a String
representation of the
Attribute
, suitable for debugging.
Returns: String
- information about the
Attribute