Class

com.github.scli.ParameterModel

ParameterKey

Related Doc: package ParameterModel

Permalink

case class ParameterKey(key: String, shortAlias: Boolean, hasPrefix: Boolean = true) extends Product with Serializable

A data class to represent the key of a parameter.

Some CLI applications distinguish between normal (long) parameter names and short alias names. On the command line, typically a different prefix is used to indicate a normal name or its alias (e.g. "--" for the normal names and "-" for short names).

To support such constellations, a plain string as parameter key is insufficient. Therefore, this class is used to represent the keys of parameters. It makes it explicit whether a string is to be interpreted as normal or short key.

There are even keys that do not have a prefix at all: keys for input parameters. Such keys can be modeled using this class as well.

key

the string-based key

shortAlias

flag whether this key is a short alias

hasPrefix

flag whether this key requires a prefix

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

Instance Constructors

  1. new ParameterKey(key: String, shortAlias: Boolean, hasPrefix: Boolean = true)

    Permalink

    key

    the string-based key

    shortAlias

    flag whether this key is a short alias

    hasPrefix

    flag whether this key requires a prefix

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 hasPrefix: Boolean

    Permalink

    flag whether this key requires a prefix

  9. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  10. val key: String

    Permalink

    the string-based key

  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 shortAlias: Boolean

    Permalink

    flag whether this key is a short alias

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

    Permalink
    Definition Classes
    AnyRef

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

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

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

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

  18. 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 AnyRef

Inherited from Any

Ungrouped