Class Attribute

java.lang.Object
org.exolab.castor.xml.dtd.Attribute

public class Attribute extends Object
Implementation of DTD Attribute declaration specification.
Version:
$Revision: 5951 $ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $
Author:
Alexander Totok
  • Constructor Summary

    Constructors
    Constructor
    Description
    Attribute(Element element, String name)
    Constructor, setting name, owning element of the attribute and occurance specification to DEFAULT.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Adds the value to the set of possible values.
    Returns default value.
    Returns Element owning this attribute.
    Returns the name of the attribute.
    Returns iterator of the set of possible values, if of NOTATION or Enumeration type, null otherwise.
    boolean
    True if attribute's default value is specified, false otherwise.
    boolean
    True if the attribute is of ENTITIES type, false otherwise.
    boolean
    True if the attribute is of ENTITY type, false otherwise.
    boolean
    True if the attribute is of Enumeration type, false otherwise.
    boolean
    True if the attribute has fixed value, false otherwise.
    boolean
    True if the attribute is of IDREFS type, false otherwise.
    boolean
    True if the attribute is of IDREF type, false otherwise.
    boolean
    True if the attribute is of ID type, false otherwise.
    boolean
    True if no default value for the attribute is provided ("IMPLIED" specification), false otherwise.
    boolean
    True if the attribute is of NMTOKENS type, false otherwise.
    boolean
    True if the attribute is of NMTOKEN type, false otherwise.
    boolean
    True if the attribute is of NOTATION type, false otherwise.
    boolean
    True if the attribute is required, false otherwise.
    boolean
    True if the attribute is of CDATA type, false otherwise.
    void
    Sets occurance specification to DEFAULT.
    void
    Sets default value.
    void
    Sets the type of the attribute to ENTITIES.
    void
    Sets the type of the attribute to ENTITY.
    void
    Sets the type of the attribute to Enumeration.
    void
    Sets occurance specification to FIXED.
    void
    Sets the type of the attribute to IDREFS.
    void
    Sets the type of the attribute to IDREF.
    void
    Sets the type of the attribute to ID.
    void
    Sets occurance specification to IMPLIED.
    void
    Sets the type of the attribute to NMTOKENS.
    void
    Sets the type of the attribute to NMTOKEN.
    void
    Sets the type of the attribute to NOTATION.
    void
    Sets occurance specification to REQUIRED.
    void
    Sets the type of the attribute to CDATA.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • Attribute

      public Attribute(Element element, String name)
      Constructor, setting name, owning element of the attribute and occurance specification to DEFAULT.
      Parameters:
      element - must not be null.
      name - must not be null or equal to empty String.
  • Method Details

    • getName

      public String getName()
      Returns the name of the attribute.
    • getElement

      public Element getElement()
      Returns Element owning this attribute.
    • getValues

      public Iterator getValues()
      Returns iterator of the set of possible values, if of NOTATION or Enumeration type, null otherwise.
    • setStringType

      public void setStringType()
      Sets the type of the attribute to CDATA.
    • isStringType

      public boolean isStringType()
      True if the attribute is of CDATA type, false otherwise.
    • setIDType

      public void setIDType()
      Sets the type of the attribute to ID.
    • isIDType

      public boolean isIDType()
      True if the attribute is of ID type, false otherwise.
    • setIDREFType

      public void setIDREFType()
      Sets the type of the attribute to IDREF.
    • isIDREFType

      public boolean isIDREFType()
      True if the attribute is of IDREF type, false otherwise.
    • setIDREFSType

      public void setIDREFSType()
      Sets the type of the attribute to IDREFS.
    • isIDREFSType

      public boolean isIDREFSType()
      True if the attribute is of IDREFS type, false otherwise.
    • setENTITYType

      public void setENTITYType()
      Sets the type of the attribute to ENTITY.
    • isENTITYType

      public boolean isENTITYType()
      True if the attribute is of ENTITY type, false otherwise.
    • setENTITIESType

      public void setENTITIESType()
      Sets the type of the attribute to ENTITIES.
    • isENTITIESType

      public boolean isENTITIESType()
      True if the attribute is of ENTITIES type, false otherwise.
    • setNMTOKENType

      public void setNMTOKENType()
      Sets the type of the attribute to NMTOKEN.
    • isNMTOKENType

      public boolean isNMTOKENType()
      True if the attribute is of NMTOKEN type, false otherwise.
    • setNMTOKENSType

      public void setNMTOKENSType()
      Sets the type of the attribute to NMTOKENS.
    • isNMTOKENSType

      public boolean isNMTOKENSType()
      True if the attribute is of NMTOKENS type, false otherwise.
    • setNOTATIONType

      public void setNOTATIONType()
      Sets the type of the attribute to NOTATION.
    • isNOTATIONType

      public boolean isNOTATIONType()
      True if the attribute is of NOTATION type, false otherwise.
    • setEnumerationType

      public void setEnumerationType()
      Sets the type of the attribute to Enumeration.
    • isEnumerationType

      public boolean isEnumerationType()
      True if the attribute is of Enumeration type, false otherwise.
    • setDEFAULT

      public void setDEFAULT()
      Sets occurance specification to DEFAULT.
    • isDEFAULT

      public boolean isDEFAULT()
      True if attribute's default value is specified, false otherwise.
    • setREQUIRED

      public void setREQUIRED()
      Sets occurance specification to REQUIRED.
    • isREQUIRED

      public boolean isREQUIRED()
      True if the attribute is required, false otherwise.
    • setIMPLIED

      public void setIMPLIED()
      Sets occurance specification to IMPLIED.
    • isIMPLIED

      public boolean isIMPLIED()
      True if no default value for the attribute is provided ("IMPLIED" specification), false otherwise.
    • setFIXED

      public void setFIXED()
      Sets occurance specification to FIXED.
    • isFIXED

      public boolean isFIXED()
      True if the attribute has fixed value, false otherwise.
    • setDefaultValue

      public void setDefaultValue(String value)
      Sets default value.
    • getDefaultValue

      public String getDefaultValue()
      Returns default value.
    • addValue

      public void addValue(String value) throws DTDException
      Adds the value to the set of possible values.
      Throws:
      DTDException - if the value is already contained in the set of possible values.