Class OptionInfo


  • @Deprecated
    public class OptionInfo
    extends DocumentedInfo
    Deprecated.
    Will be removed in next major release.
    Defines a potential value for a parent parameter description.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String value
      Deprecated.
      Value of this option element.
    • Constructor Summary

      Constructors 
      Constructor Description
      OptionInfo()
      Deprecated.
      Constructor.
      OptionInfo​(java.lang.String documentation)
      Deprecated.
      Constructor with a single documentation element.
      OptionInfo​(java.util.List<DocumentationInfo> documentations)
      Deprecated.
      Constructor with a list of documentation elements.
      OptionInfo​(DocumentationInfo documentation)
      Deprecated.
      Constructor with a single documentation element.
    • Field Detail

      • value

        private java.lang.String value
        Deprecated.
        Value of this option element.
    • Constructor Detail

      • OptionInfo

        public OptionInfo()
        Deprecated.
        Constructor.
      • OptionInfo

        public OptionInfo​(DocumentationInfo documentation)
        Deprecated.
        Constructor with a single documentation element.
        Parameters:
        documentation - A single documentation element.
      • OptionInfo

        public OptionInfo​(java.util.List<DocumentationInfo> documentations)
        Deprecated.
        Constructor with a list of documentation elements.
        Parameters:
        documentations - The list of documentation elements.
      • OptionInfo

        public OptionInfo​(java.lang.String documentation)
        Deprecated.
        Constructor with a single documentation element.
        Parameters:
        documentation - A single documentation element.
    • Method Detail

      • getValue

        public java.lang.String getValue()
        Deprecated.
        Returns the value of this option element.
        Returns:
        The value of this option element.
      • setValue

        public void setValue​(java.lang.String value)
        Deprecated.
        Sets the value of this option element.
        Parameters:
        value - The value of this option element.
      • updateNamespaces

        public void updateNamespaces​(java.util.Map<java.lang.String,​java.lang.String> namespaces)
        Deprecated.
        Description copied from class: DocumentedInfo
        Completes the given map of namespaces with the namespaces used in the documentation elements. The key is the URI of the namespace and the value, the prefix.
        Specified by:
        updateNamespaces in class DocumentedInfo
        Parameters:
        namespaces - The given map of namespaces to complete.
      • writeElement

        public void writeElement​(XmlWriter writer)
                          throws org.xml.sax.SAXException
        Deprecated.
        Writes the current object as an XML element using the given SAX writer.
        Parameters:
        writer - The SAX writer.
        Throws:
        org.xml.sax.SAXException