Class

com.github.scli.ParameterParser

OptionElement

Related Doc: package ParameterParser

Permalink

case class OptionElement(key: ParameterKey, optValue: Option[String], index: Int = 0) extends CliElement with Product with Serializable

A concrete CliElement class representing an option.

The option is identified by its key. If possible, its value is extracted; but this may noe be possible, for instance if the option key was the last parameter on the command line.

key

the key of the option

optValue

an Option with the value

index

the index of this element on the command line

Linear Supertypes
Serializable, Serializable, Product, Equals, CliElement, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OptionElement
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. CliElement
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OptionElement(key: ParameterKey, optValue: Option[String], index: Int = 0)

    Permalink

    key

    the key of the option

    optValue

    an Option with the value

    index

    the index of this element on the command line

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  8. val index: Int

    Permalink

    the index of this element on the command line

    the index of this element on the command line

    Definition Classes
    OptionElementCliElement
  9. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  10. val key: ParameterKey

    Permalink

    the key of the option

    the key of the option

    Definition Classes
    OptionElementCliElement
  11. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  14. val optValue: Option[String]

    Permalink

    an Option with the value

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

    Permalink
    Definition Classes
    AnyRef
  16. def value: String

    Permalink

    Returns the raw value of this CliElement as specified by the user.

    Returns the raw value of this CliElement as specified by the user. The value may be transformed during the extraction phase. If transformation fails, it might be useful to have the original value to construct an error message.

    returns

    the value of this CliElement

    Definition Classes
    OptionElementCliElement
  17. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. 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 CliElement

Inherited from AnyRef

Inherited from Any

Ungrouped