Class Option<T>

    • Constructor Detail

      • Option

        public Option()
    • Method Detail

      • getName

        public String getName()
      • setName

        public void setName​(String name)
      • getDescription

        public List<String> getDescription()
      • setDescription

        public void setDescription​(List<String> description)
      • getMandatory

        public Boolean getMandatory()
        Returns:
        null means optional
      • isMandatory

        public boolean isMandatory()
      • setMandatory

        public void setMandatory​(Boolean mandatory)
      • getMeaning

        public List<String> getMeaning()
        Returns:
        The meaning of a value of this data type. Most of the time the meaning is a word describing the data type itself. E. g. "number" or "path". Sometimes there are better names like "id", "file", "directory", "name", "format" etc. The meaning will be printed like this in the help page: <meaning>
      • setMeaning

        public void setMeaning​(List<String> meaning)
      • getValidValues

        public List<ValidValues<T>> getValidValues()
        If any of the element in this list validates a given value as correct, then it is correct. Hence, the list is meant as union set of valid values.
      • setValidValues

        public void setValidValues​(List<ValidValues<T>> validValues)
      • convertImpl

        protected abstract T convertImpl​(OptionValue ov)
                                  throws InvalidValueException
        Converts a string-typed argument to the type represented by this DataType. No validation against valid values will happen.
        Parameters:
        ov -
        Returns:
        converted value
        Throws:
        InvalidValueException