Class Attribute

java.lang.Object
org.jdom2.Attribute
All Implemented Interfaces:
Serializable, Cloneable, NamespaceAware
public class Attribute extends Object implements NamespaceAware, Serializable, Cloneable
An XML attribute. Methods allow the user to obtain the value of the attribute as well as namespace and type information.

JDOM 1.x Compatibility Note:
The Attribute class in JDOM 1.x had a number of int Constants declared to represent different Attribute Types. JDOM2 has introduced an AttributeType enumeration instead. To facilitate compatibility and to simplify JDOM 1.x migrations, the replacement AttributeType enums are referenced still using the JDOM 1.x constant names. In JDOM 1.x these names referenced constant int values. In JDOM2 these names reference Enum constants.

Author:
Brett McLaughlin, Jason Hunter, Elliotte Rusty Harold, Wesley Biggs, Victor Toni, Rolf Lear
See Also:

  • Field Details

  • Constructor Details

    • Attribute

      protected Attribute()
      Default, no-args constructor for implementations to use if needed.

    • 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 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.checkCharacterData(String)).

    • Attribute

      @Deprecated public Attribute(String name, String value, int type, Namespace namespace)
      Deprecated.
      Use Attribute(String, String, AttributeType, Namespace).
      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.
      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.checkCharacterData(String)) or if the given attribute type is not one of the supported types.

    • Attribute

      public Attribute(String name, String value, AttributeType type, Namespace namespace)
      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 - AttributeType 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.checkCharacterData(String)) or if the given attribute type is not one of the supported types.

    • 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).

      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.checkCharacterData(String)).

    • Attribute

      public Attribute(String name, String value, AttributeType 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).

      Parameters:
      name - String name of Attribute.
      value - String value for new attribute.
      type - AttributeType 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.checkCharacterData(String)) or if the given attribute type is not one of the supported types.

    • Attribute

      @Deprecated public Attribute(String name, String value, int type)
      Deprecated.
      Use Attribute(String, String, AttributeType)
      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).

      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.checkCharacterData(String)) or if the given attribute type is not one of the supported types.

  • Method Details

    • getParent

      public Element getParent()
      This will return the parent of this Attribute. If there is no parent, then this returns null. Use return-type covariance to override Content's getParent() method to return an Element, not just a Parent
      Returns:
      parent of this Attribute

    • getDocument

      public Document getDocument()
      Get this Attribute's Document.
      Returns:
      The document to which this Attribute is associated, may be null.

    • 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 getNamespacePrefix() method should be used.

      Returns:
      String - name of this attribute, without any namespace prefix.

    • setName

      public Attribute setName(String name)
      This sets the local name of the 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.

    • 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 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.

    • 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.

    • 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.

    • getNamespace

      public Namespace getNamespace()
      This will return this Attribute's Namespace.
      Returns:
      Namespace - Namespace object for this Attribute

    • setNamespace

      public Attribute setNamespace(Namespace namespace)
      This sets this 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.

    • 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.

    • 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 Verifier.checkCharacterData(String)).

    • getAttributeType

      public AttributeType getAttributeType()
      This will return the declared type of this Attribute.
      Returns:
      AttributeType - type for this attribute.

    • setAttributeType

      public Attribute setAttributeType(AttributeType type)
      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.

    • setAttributeType

      @Deprecated public Attribute setAttributeType(int type)
      Deprecated.
      use setAttributeType(AttributeType)
      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.

    • isSpecified

      public boolean isSpecified()
      Get the 'specified' flag. True values indicate this attribute was part of an XML document, false indicates it was defaulted from a DTD.
      Returns:
      the specified flag.
      Since:
      JDOM2

    • setSpecified

      public void setSpecified(boolean specified)
      Change the specified flag to the given value.
      Parameters:
      specified - The value to set the specified flag to.
      Since:
      JDOM2

    • toString

      public String toString()
      This returns a String representation of the Attribute, suitable for debugging.
      Overrides:
      toString in class Object
      Returns:
      String - information about the Attribute

    • clone

      public Attribute clone()
      Return a deep clone of this instance. Even if this instance has a parent, the returned clone will not.

      All JDOM core classes are Cloneable, and never throw CloneNotSupportedException. Additionally all Cloneable JDOM classes return the correct type of instance from this method and there is no need to cast the result (co-variant return value).

      Subclasses of this should still call super.clone() in their clone method.

    • detach

      public Attribute detach()
      Detach this Attribute from its parent.
      Returns:
      this Attribute (detached).

    • setParent

      protected Attribute setParent(Element parent)
      Set this Attribute's parent. This is not public!
      Parameters:
      parent - The parent to set
      Returns:
      this Attribute (state may be indeterminate depending on whether this has been included in the Element's list yet).

    • getIntValue

      public int getIntValue() throws DataConversionException
      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.

    • getLongValue

      public long getLongValue() throws DataConversionException
      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.

    • getFloatValue

      public float getFloatValue() throws DataConversionException
      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.

    • getDoubleValue

      public double getDoubleValue() throws DataConversionException
      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.

    • getBooleanValue

      public boolean getBooleanValue() throws DataConversionException
      This gets the effective boolean value of the attribute, or throws a 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.

    • getNamespacesInScope

      public List<Namespace> getNamespacesInScope()
      Get the namespaces that are in-scope on this Attribute.

      Attribute has peculiarities that affect the in-scope Namespaces because there are conditions in which the Attribute's scope is different to its parent Element's scope. Specifically, if the parent Element is in a 'default' Namespace that is not the empty Namespace (e.g. xmlns="someurl") and this Attribute is also in the default Namespace (has no prefix - but for Attributes that means the Namespace URL is ""), then this Attribute has a different namespace scope from its parent Element because it does not include the 'someurl' Namespace.

      In the above conditions (no-prefix Attribute in an Element with a non-empty no-prefix Namespace) this Attribute effectively re-binds the "" prefix to the "" URL, thus the Attribute 'introduces' the Namespace. It follows then that the getNamespacesIntroduced() will return a list with the single member Namespace.NO_NAMESPACE.

      Note that the Attribute's Namespace will always be reported first.

      Description copied from NamespaceAware.getNamespacesInScope():

      Obtain a list of all namespaces that are in scope for the current content.

      The contents of this list will always be the combination of getNamespacesIntroduced() and getNamespacesInherited().

      See NamespaceAware documentation for details on what the order of the Namespaces will be in the returned list.

      Specified by:
      getNamespacesInScope in interface NamespaceAware
      Returns:
      a read-only list of Namespaces.

    • getNamespacesIntroduced

      public List<Namespace> getNamespacesIntroduced()
      Description copied from interface: NamespaceAware
      Obtain a list of all namespaces that are introduced to the XML tree by this node. Only Elements and Attributes can introduce namespaces, so all other Content types will return an empty list.

      The contents of this list will always be a subset (but in the same order) of getNamespacesInScope(), and will never intersect getNamspacesInherited()

      Specified by:
      getNamespacesIntroduced in interface NamespaceAware
      Returns:
      a read-only list of Namespaces.

    • getNamespacesInherited

      public List<Namespace> getNamespacesInherited()
      Description copied from interface: NamespaceAware
      Obtain a list of all namespaces that are in scope for this content, but were not introduced by this content.

      The contents of this list will always be a subset (but in the same order) of getNamespacesInScope(), and will never intersect getNamspacesIntroduced()

      Specified by:
      getNamespacesInherited in interface NamespaceAware
      Returns:
      a read-only list of Namespaces.