All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.jdom.Attribute

java.lang.Object
   |
   +----org.jdom.Attribute

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:
1.0
Author:
Brett McLaughlin, Jason Hunter, Elliotte Rusty Harold, Wesley Biggs

Variable Index

 o name
The local name of the Attribute
 o namespace
The {
 o parent
Parent element, or null if none
 o value
The value of the Attribute

Constructor Index

 o Attribute()

Default, no-args constructor for implementations to use if needed.

 o Attribute(String, String)

This will create a new Attribute with the specified (local) name and value, and does not place the attribute in a {

 o Attribute(String, String, Namespace)

This will create a new Attribute with the specified (local) name and value, and in the provided {

 o Attribute(String, String, String, String)

This will create a new Attribute with the specified (local) name and value, and place it in the specified namespace (with prefix). Deprecated.

Method Index

 o clone()

This will return a clone of this Attribute.

 o detach()

This detaches the Attribute from its parent, or does nothing if the Attribute has no parent.

 o equals(Object)

This tests for equality of this Attribute to the supplied Object.

 o getBooleanValue()

This gets the value of the attribute, in boolean form, and if no conversion can occur, throws a {

 o getDocument()

This retrieves the owning {

 o getDoubleValue()

This gets the value of the attribute, in double form, and if no conversion can occur, throws a {

 o getFloatValue()

This gets the value of the attribute, in float form, and if no conversion can occur, throws a {

 o getIntValue()

This gets the value of the attribute, in int form, and if no conversion can occur, throws a {

 o getLongValue()

This gets the value of the attribute, in long form, and if no conversion can occur, throws a {

 o getName()

This will retrieve the local name of the Attribute.

 o getNamespace()

This will return this Attribute's {

 o getNamespacePrefix()

This will retrieve the namespace prefix of the Attribute.

 o getNamespaceURI()

This returns the URI mapped to this Attribute's prefix.

 o getParent()

This will return the parent of this Attribute.

 o getQualifiedName()

This will retrieve the qualified name of the Attribute.

 o getSerializedForm()

This will return the Attribute in XML format, usable in an XML document. Deprecated.

 o getValue()

This will return the actual textual value of this Attribute.

 o hashCode()

This returns the hash code for this Attribute.

 o setName(String)

This sets the local name of the Attribute.

 o setNamespace(Namespace)

This sets this Attribute's {

 o setParent(Element)

This will set the parent of this Comment.

 o setValue(String)

This will set the value of the Attribute.

 o toString()

This returns a String representation of the Attribute, suitable for debugging.

Variables

 o name
 protected String name
The local name of the Attribute

 o namespace
 protected transient Namespace namespace
The {@link Namespace} of the Attribute

 o value
 protected String value
The value of the Attribute

 o parent
 protected Element parent
Parent element, or null if none

Constructors

 o Attribute
 protected Attribute()

Default, no-args constructor for implementations to use if needed.

 o Attribute
 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 {@link Namespace}.

Parameters:
name - String name of Attribute.
value - String value for new attribute.
 o 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 {@link Namespace}.

Note: This actually explicitly puts the Attribute in the "empty" Namespace ({@link Namespace#NO_NAMESPACE}).

Parameters:
name - String name of Attribute.
value - String value for new attribute.
 o Attribute
 public Attribute(String name,
                  String prefix,
                  String uri,
                  String value)
Note: Attribute() is deprecated. Deprecated in beta7, use Attribute(String name, String value, Namespace namespace) instead

This will create a new Attribute with the specified (local) name and value, and place it in the specified namespace (with prefix).

Parameters:
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.

Methods

 o getParent
 public Element getParent()

This will return the parent of this Attribute. If there is no parent, then this returns null.

Returns:
parent of this Attribute
 o getDocument
 public Document getDocument()

This retrieves the owning {@link Document} for this Attribute, or null if not a currently a member of a {@link Document}.

Returns:
Document owning this Attribute, or null.
 o setParent
 protected Attribute setParent(Element parent)

This will set the parent of this Comment.

Parameters:
parent - Element to be new parent.
Returns:
this Comment modified.
 o detach
 public Attribute detach()

This detaches the Attribute from its parent, or does nothing if the Attribute has no parent.

Returns:
Attribute - this Attribute modified.
 o getName
 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 {@link #getNamespacePrefix()} method should be used.

Returns:
String - name of this attribute, without any namespace prefix.
 o setName
 public Attribute setName(String name)

This sets the local name of the Attribute.

Returns:
Attribute - the attribute modified.
Throws: IllegalNameException
if the given name is invalid as an attribute name.
 o getQualifiedName
 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 {@link #getName()} method should be used.

To obtain the namespace prefix for this attribute, the {@link #getNamespacePrefix()} method should be used.

Returns:
String - full name for this element.
 o getNamespacePrefix
 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.

Returns:
String - namespace prefix of this attribute.
 o getNamespaceURI
 public String getNamespaceURI()

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.
 o getNamespace
 public Namespace getNamespace()

This will return this Attribute's {@link Namespace}.

Returns:
Namespace - Namespace object for this Attribute
 o setNamespace
 public Attribute setNamespace(Namespace namespace)

This sets this Attribute's {@link 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.
 o getValue
 public String getValue()

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.
 o setValue
 public Attribute setValue(String value)

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 {@link org.jdom.Verifier#checkCharacterData}).
 o toString
 public String toString()

This returns a String representation of the Attribute, suitable for debugging.

Returns:
String - information about the Attribute
Overrides:
toString in class Object
 o equals
 public final boolean equals(Object ob)

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.
Overrides:
equals in class Object
 o hashCode
 public final int hashCode()

This returns the hash code for this Attribute.

Returns:
int - hash code.
Overrides:
hashCode in class Object
 o clone
 public Object clone()

This will return a clone of this Attribute.

Returns:
Object - clone of this Attribute.
Overrides:
clone in class Object
 o getIntValue
 public int getIntValue() throws DataConversionException

This gets the value of the attribute, in int form, and if no conversion can occur, throws a {@link DataConversionException}

Returns:
int value of attribute.
Throws: DataConversionException
when conversion fails.
 o getLongValue
 public long getLongValue() throws DataConversionException

This gets the value of the attribute, in long form, and if no conversion can occur, throws a {@link DataConversionException}

Returns:
long value of attribute.
Throws: DataConversionException
when conversion fails.
 o getFloatValue
 public float getFloatValue() throws DataConversionException

This gets the value of the attribute, in float form, and if no conversion can occur, throws a {@link DataConversionException}

Returns:
float value of attribute.
Throws: DataConversionException
when conversion fails.
 o getDoubleValue
 public double getDoubleValue() throws DataConversionException

This gets the value of the attribute, in double form, and if no conversion can occur, throws a {@link DataConversionException}

Returns:
double value of attribute.
Throws: DataConversionException
when conversion fails.
 o getBooleanValue
 public boolean getBooleanValue() throws DataConversionException

This gets the value of the attribute, in boolean form, and if no conversion can occur, throws a {@link DataConversionException}

Returns:
boolean value of attribute.
Throws: DataConversionException
when conversion fails.
 o getSerializedForm
 public final String getSerializedForm()
Note: getSerializedForm() is deprecated. Deprecated in Beta7, use XMLOutputter.outputString(Attribute) instead

This will return the Attribute in XML format, usable in an XML document.

Returns:
String - the serialized form of the Attribute.

All Packages  Class Hierarchy  This Package  Previous  Next  Index