Class

de.h2b.scala.lib.util.cli

FlagParameter

Related Doc: package cli

Permalink

case class FlagParameter(names: Set[String], description: String) extends Parameter[Boolean] with SingleValue[Boolean] with Product with Serializable

A flag parameter has no specific value, it just signals that it is there.

If its value is defined, it is present in the command line, else it is not.

Linear Supertypes
Serializable, Serializable, Product, Equals, SingleValue[Boolean], Parameter[Boolean], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FlagParameter
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SingleValue
  7. Parameter
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FlagParameter(names: Set[String], description: String)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. val arity: Int

    Permalink

    Specification of values following this parameter name:

    Specification of values following this parameter name:

    - positive number: exactly this number of values must follow this parameter name

    - negative number: at least abs(this number) of values must follow this parameter name (variable arity)

    - zero: no values must follow this parameter name

    Values following this parameter name will be consumed up to the next parameter.

    Definition Classes
    FlagParameter → Parameter

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  7. val default: Option[Boolean]

    Permalink
    Definition Classes
    FlagParameter → SingleValue

  8. val description: String

    Permalink
    Definition Classes
    FlagParameter → Parameter

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  11. val hidden: Boolean

    Permalink
    Definition Classes
    Parameter

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. val names: Set[String]

    Permalink
    Definition Classes
    FlagParameter → Parameter

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  17. val required: Boolean

    Permalink
    Definition Classes
    FlagParameter → Parameter

  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  19. def usage(namesColWidth: Int = 0): String

    Permalink

    A usage message of this parameter in a two-column layout.

    A usage message of this parameter in a two-column layout.

    The first column shows the names in one line, the second column shows one ore more lines of description. The lines of the description are taken as given, no automatic word wrap is done.

    namesColWidth

    minimum width of the names column (defaults to 0)

    returns

    the usage message

    Definition Classes
    Parameter

  20. def value: Option[Boolean]

    Permalink
    Definition Classes
    SingleValue

  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SingleValue[Boolean]

Inherited from Parameter[Boolean]

Inherited from AnyRef

Inherited from Any

Ungrouped