org.jdom
public class Attribute extends Object implements Serializable, Cloneable
Version: $Revision: 1.56 $, $Date: 2007/11/10 05:28:58 $
Field Summary | |
---|---|
static int | CDATA_TYPE
Attribute type: the attribute value is a string.
|
static int | ENTITIES_TYPE Attribute type: the attribute value is a list of entity names. |
static int | ENTITY_TYPE
Attribute type: the attribute value is the name of an entity.
|
static int | ENUMERATED_TYPE
Attribute type: the attribute value is a name token from an
enumeration.
|
static int | IDREFS_TYPE
Attribute type: the attribute value is a list of references to
unique identifiers.
|
static int | IDREF_TYPE
Attribute type: the attribute value is a reference to a
unique identifier.
|
static int | ID_TYPE
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_TYPE
Attribute type: the attribute value is a list of name tokens.
|
static int | NMTOKEN_TYPE
Attribute type: the attribute value is a name token.
|
static int | NOTATION_TYPE
Attribute type: the attribute value is the name of a notation.
|
protected Element | parent Parent element, or null if none |
protected int | type The type of the Attribute |
static int | UNDECLARED_TYPE
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 with the
specified (local) name and value, and in the provided
Namespace .
| |
Attribute(String name, 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 .
| |
Attribute(String name, String value)
This will create a new Attribute with the
specified (local) name and value, and does not place
the attribute in a Namespace .
| |
Attribute(String name, 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 .
|
Method Summary | |
---|---|
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(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 effective boolean value of the attribute, or throws a
DataConversionException if a conversion can't be
performed. |
Document | getDocument() |
double | getDoubleValue()
This gets the value of the attribute, in
double form, and if no conversion
can occur, throws a
DataConversionException
|
float | getFloatValue()
This gets the value of the attribute, in
float form, and if no conversion
can occur, throws a
DataConversionException
|
int | getIntValue()
This gets the value of the attribute, in
int form, and if no conversion
can occur, throws a
DataConversionException
|
long | getLongValue()
This gets the value of the attribute, in
long form, and if no conversion
can occur, throws a
DataConversionException
|
String | getName()
This will retrieve the local name of the
Attribute . |
Namespace | getNamespace()
This will return this Attribute 's
Namespace .
|
String | getNamespacePrefix()
This will retrieve the namespace prefix of the
Attribute . |
String | getNamespaceURI()
This returns the URI mapped to this Attribute 's
prefix. |
Element | getParent()
This will return the parent of this Attribute .
|
String | getQualifiedName()
This will retrieve the qualified name of the Attribute .
|
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(String name)
This sets the local name of the Attribute .
|
Attribute | setNamespace(Namespace namespace)
This sets this Attribute 's Namespace .
|
protected Attribute | setParent(Element parent)
This will set the parent of this Attribute .
|
Attribute | setValue(String value)
This will set the value of the Attribute .
|
String | toString()
This returns a String representation of the
Attribute , suitable for debugging.
|
See Also: Attribute
Attribute type: the attribute value is a list of entity names.
See Also: Attribute
See Also: Attribute
See Also: Attribute
See Also: Attribute
See Also: Attribute
See Also: Attribute
Attribute
Namespace
of the Attribute
See Also: Attribute
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_TYPE.
See Also: Attribute
See Also: Attribute
Attribute
See Also: Attribute
Attribute
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.
Throws: IllegalNameException if the given name is illegal as an attribute name or if if the new namespace is the default namespace. Attributes cannot be in a default namespace. IllegalDataException if the given attribute value is illegal character data (as determined by Verifier).
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.
Throws: IllegalNameException if the given name is illegal as an attribute name or if if the new namespace is the default namespace. Attributes cannot be in a default namespace. IllegalDataException if the given attribute value is illegal character data (as determined by Verifier) or if the given attribute type is not one of the supported types.
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.
Throws: IllegalNameException if the given name is illegal as an attribute name. IllegalDataException if the given attribute value is illegal character data (as determined by Verifier).
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.
Throws: IllegalNameException if the given name is illegal as an attribute name. IllegalDataException if the given attribute value is illegal character data (as determined by Verifier) or if the given attribute type is not one of the supported types.
Attribute
.
Returns: Object
- clone of this Attribute
.
Attribute
from its parent, or does
nothing if the Attribute
has no parent.
Returns: Attribute
- this Attribute
modified.
Attribute
to the supplied
Object
.
Parameters: ob Object
to compare to.
Returns: boolean
- whether the Attribute
is
equal to the supplied Object
.
Attribute
.
Returns: int
- type for this attribute.
DataConversionException
if a conversion can't be
performed. True values are: "true", "on", "1", and "yes". False
values are: "false", "off", "0", and "no". Values are trimmed before
comparison. Values other than those listed here throw the exception.
Returns: boolean
value of attribute.
Throws: DataConversionException when conversion fails.
Document
for
this Attribute, or null if not a currently a member of a
Document
.
Returns: Document
owning this Attribute, or null.
double
form, and if no conversion
can occur, throws a
DataConversionException
Returns: double
value of attribute.
Throws: DataConversionException when conversion fails.
float
form, and if no conversion
can occur, throws a
DataConversionException
Returns: float
value of attribute.
Throws: DataConversionException when conversion fails.
int
form, and if no conversion
can occur, throws a
DataConversionException
Returns: int
value of attribute.
Throws: DataConversionException when conversion fails.
long
form, and if no conversion
can occur, throws a
DataConversionException
Returns: long
value of attribute.
Throws: DataConversionException when conversion fails.
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.
Attribute
's
Namespace
.
Returns: Namespace
- Namespace object for this Attribute
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.
Attribute
's
prefix. If no mapping is found, an empty String
is
returned.
Returns: String
- namespace URI for this Attribute
.
Attribute
.
If there is no parent, then this returns null
.
Returns: parent of this Attribute
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.
Attribute
. This will include all text
within the quotation marks.
Returns: String
- value for this attribute.
Attribute
.
Returns: int
- hash code.
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.
Attribute
.
Parameters: name the new local name to set
Returns: Attribute
- the attribute modified.
Throws: IllegalNameException if the given name is illegal as an attribute name.
Attribute
's Namespace
.
If the provided namespace is null, the attribute will have no namespace.
The namespace must have a prefix.
Parameters: namespace the new namespace
Returns: Element
- the element modified.
Throws: IllegalNameException if the new namespace is the default namespace. Attributes cannot be in a default namespace.
Attribute
.
Parameters: parent Element
to be new parent.
Returns: this Attribute
modified.
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).
String
representation of the
Attribute
, suitable for debugging.
Returns: String
- information about the
Attribute