|
||||||||||
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 | |
protected String |
name
The local name of the Attribute |
protected Namespace |
namespace
The of the Attribute |
protected Element |
parent
Parent element, or null if none |
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)
This will create a new Attribute with the
specified (local) name and value, and does not place
the attribute in a . |
|
Attribute(String name,
String value,
Namespace namespace)
This will create a new Attribute with the
specified (local) name and value, and in the provided
. |
|
Attribute(String name,
String prefix,
String uri,
String value)
Deprecated. Deprecated in beta7, use Attribute(String name, String value, Namespace namespace) instead |
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 . |
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
|
String |
getName()
This will retrieve the local name of the Attribute . |
Namespace |
getNamespace()
This will return this Attribute 's
. |
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 |
getSerializedForm()
Deprecated. Deprecated in Beta7, use XMLOutputter.outputString(Attribute) instead |
String |
getValue()
This will return the actual textual value of this Attribute . |
int |
hashCode()
This returns the hash code for this Attribute . |
Attribute |
setName(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 Comment . |
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. |
Methods inherited from class java.lang.Object |
finalize,
getClass,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
protected String name
Attribute
protected transient Namespace namespace
Namespace
of the Attribute
protected String value
Attribute
protected Element parent
Constructor Detail |
protected Attribute()
Default, no-args constructor for implementations to use if needed.
public 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
name
- String
name of Attribute
.value
- String
value for new attribute.public 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
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(String name, String prefix, String uri, String value)
This will create a new Attribute
with the
specified (local) name and value, and place it in
the specified namespace (with prefix).
name
- String
name of Attribute
.prefix
- String
prefix for Attribute
.uri
- String
URI for namespace this
Attribute
is in.value
- String
value 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 Comment
.
parent
- Element
to be new parent.Comment
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 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(String name)
This sets the local name of the Attribute
.
Attribute
- the attribute modified.public 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 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 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.public 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(String value)
This will set the value of the Attribute
.
value
- String
value for the attribute.Attribute
- this Attribute modified.Verifier.checkCharacterData(java.lang.String)
).public String toString()
This returns a String
representation of the
Attribute
, suitable for debugging.
String
- information about the
Attribute
public final boolean equals(Object ob)
This tests for equality of this Attribute
to the supplied
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
.
int
- hash code.public Object clone()
This will return a clone of this Attribute
.
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.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.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.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.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.public final String getSerializedForm()
This will return the Attribute
in XML format,
usable in an XML document.
String
- the serialized form of the
Attribute
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |