Package org.apache.uima.resource.metadata

# Interface AllowedValue

All Superinterfaces:
  `Cloneable`, `MetaDataObject`, `Serializable`, `XMLizable`

All Known Implementing Classes:
  `AllowedValue_impl`

public interface AllowedValue extends MetaDataObject
Represents an allowed value for an "enumerated" type.

See Also:
  - `TypeDescription`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getDescription()`
  Gets the verbose description of this allowed value.
  `String`
  `getString()`
  Gets the allowed value.
  `void`
  `setDescription(String aDescription)`
  Sets the verbose description of this allowed value.
  `void`
  `setString(String aString)`
  Sets the allowed value.

  ### Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject

  `clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl`

  ### Methods inherited from interface org.apache.uima.util.XMLizable

  `buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML`

- ## Method Details

  - ### getString

    String getString()
    Gets the allowed value.
    Returns:
      the allowed value string

  - ### setString

    void setString(String aString)
    Sets the allowed value.
    Parameters:
      `aString` - the allowed value string

  - ### getDescription

    String getDescription()
    Gets the verbose description of this allowed value.
    Returns:
      the description of this allowed value

  - ### setDescription

    void setDescription(String aDescription)
    Sets the verbose description of this allowed value.
    Parameters:
      `aDescription` - the description of this allowed value