Class AbstractParameter

  • All Implemented Interfaces:
    Cloneable
    Direct Known Subclasses:
    Flag, Option

    public abstract class AbstractParameter
    extends Object
    implements Cloneable
    Command Line parameter superclass
    • Constructor Detail

      • AbstractParameter

        public AbstractParameter()
    • Method Detail

      • getDescription

        public String getDescription()
        Returns:
        the description
      • getLocalizedDescription

        public abstract String getLocalizedDescription()
        Returns:
        the localized description
      • getName

        public String getName()
        Returns:
        the name
      • setDescription

        public void setDescription​(String description)
        Parameters:
        description - The description to set
      • setName

        public void setName​(String name)
        Parameters:
        name - the name to set
      • getValue

        public String getValue()
        Returns:
        the value
      • setValue

        public void setValue​(String value)
        Parameters:
        value - The value to set
      • getLongName

        public String getLongName()
        Returns:
        the longName
      • setLongName

        public void setLongName​(String longName)
        Parameters:
        longName - The longName to set
      • clone

        protected void clone​(AbstractParameter param)
        Parameters:
        param - the AbstractParameter to clone
      • getContextKey

        public String getContextKey()
        Returns:
        the commandAttribute. if the context key is unset it returns the parameter name
      • setContextKey

        public void setContextKey​(String commandAttribute)
        Parameters:
        commandAttribute - The commandAttribute to set
      • isRequired

        public abstract boolean isRequired()
        Returns:
        true if this parameter is mandatory
      • getLocalizedArgName

        public abstract String getLocalizedArgName()
        Returns:
        argumentlocalized name