Class CollectionArgumentChoice<E>

java.lang.Object
net.sourceforge.argparse4j.impl.choice.CollectionArgumentChoice<E>
All Implemented Interfaces:
ArgumentChoice

public class CollectionArgumentChoice<E> extends Object implements ArgumentChoice

Choice from given collection of values.

contains(Object) checks given val is contained in values given in constructor argument.

  • Constructor Details

    • CollectionArgumentChoice

      public CollectionArgumentChoice(E... values)
      Initializes this object from given values.
      Parameters:
      values - Valid values
    • CollectionArgumentChoice

      public CollectionArgumentChoice(Collection<E> values)
      Initializes this object from given values.
      Parameters:
      values - Valid values
  • Method Details

    • contains

      public boolean contains(Object val)
      Description copied from interface: ArgumentChoice

      Returns true iff val is valid choice according to this object's constraint.

      If the objects derived from RuntimeException are thrown because of invalid input from command line, subclass must catch these exceptions and return false.

      Specified by:
      contains in interface ArgumentChoice
      Parameters:
      val - The attribute value.
      Returns:
      true or false.
    • textualFormat

      public String textualFormat()
      Description copied from interface: ArgumentChoice

      Return textual representation of this choice.

      This string will be used in help and error messages.

      Specified by:
      textualFormat in interface ArgumentChoice
      Returns:
      The textual representation of this choice.
    • toString

      public String toString()
      Overrides:
      toString in class Object