Packages

c

scala.cli.config.Key

KeyWithJsonCodec

abstract class KeyWithJsonCodec[T] extends Key[T]

Linear Supertypes
Key[T], AnyRef, Any
Known Subclasses
BooleanEntry, StringEntry, StringListEntry
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KeyWithJsonCodec
  2. Key
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new KeyWithJsonCodec()(implicit jsonCodec: JsonValueCodec[T])

Abstract Value Members

  1. abstract def asString(value: T): Seq[String]

    Converts a value of this key to a sequence of strings

    Converts a value of this key to a sequence of strings

    Such a sequence can be printed in the console, and converted back to a T with fromString.

    Definition Classes
    Key
  2. abstract def description: String

    A short description of a particular key's purpose and syntax for its values.

    A short description of a particular key's purpose and syntax for its values.

    Definition Classes
    Key
  3. abstract def fromString(values: Seq[String]): Either[MalformedValue, T]

    Reads a value of this key from a sequence of string

    Reads a value of this key from a sequence of string

    Definition Classes
    Key
  4. abstract def name: String

    Key name, such as "b" in "foo.a.b"

    Key name, such as "b" in "foo.a.b"

    Definition Classes
    Key
  5. abstract def prefix: Seq[String]

    Key prefix, such as "foo.a" in "foo.a.b"

    Key prefix, such as "foo.a" in "foo.a.b"

    Definition Classes
    Key
  6. abstract def specificationLevel: SpecificationLevel

    The SpecificationLevel of the key.

    The SpecificationLevel of the key. SpecificationLevel.RESTRICTED && SpecificationLevel.EXPERIMENTAL keys are only available in power mode.

    Definition Classes
    Key

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def fullName: String

    The fully qualified name of this key

    The fully qualified name of this key

    Definition Classes
    Key
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hidden: Boolean

    A flag indicating whether the key should by default be hidden in help outputs or not.

    A flag indicating whether the key should by default be hidden in help outputs or not.

    Definition Classes
    Key
  13. def isExperimental: Boolean
    Definition Classes
    Key
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def isPasswordOption: Boolean

    Whether this key corresponds to a password (see Key.PasswordEntry)

    Whether this key corresponds to a password (see Key.PasswordEntry)

    Definition Classes
    Key
  16. def isRestricted: Boolean
    Definition Classes
    Key
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. def parse(json: Array[Byte]): Either[EntryError, T]

    Try to parse a value of this key

    Try to parse a value of this key

    Definition Classes
    KeyWithJsonCodec → Key
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  26. def write(value: T): Array[Byte]

    Converts a value of this key to JSON

    Converts a value of this key to JSON

    returns

    UTF-8 encoded JSON

    Definition Classes
    KeyWithJsonCodec → Key

Inherited from Key[T]

Inherited from AnyRef

Inherited from Any

Ungrouped