config
API
Generated with
config/scala.cli.config/Key/StringListEntry

StringListEntry

scala.cli.config.Key$.StringListEntry
final class StringListEntry(val prefix: Seq[String], val name: String, val specificationLevel: SpecificationLevel, val description: String, val hidden: Boolean) extends KeyWithJsonCodec[List[String]]

Attributes

Graph
Supertypes
class KeyWithJsonCodec[List[String]]
class Key[List[String]]
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def asString(value: List[String]): 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.

Attributes

def fromString(values: Seq[String]): Either[MalformedValue, List[String]]

Reads a value of this key from a sequence of string

Reads a value of this key from a sequence of string

Attributes

Inherited methods

final def fullName: String

The fully qualified name of this key

The fully qualified name of this key

Attributes

Inherited from:
Key
def isExperimental: Boolean

Attributes

Inherited from:
Key
def isPasswordOption: Boolean

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

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

Attributes

Inherited from:
Key
def isRestricted: Boolean

Attributes

Inherited from:
Key
def parse(json: Array[Byte]): Either[EntryError, T]

Try to parse a value of this key

Try to parse a value of this key

Attributes

Inherited from:
KeyWithJsonCodec
def write(value: List[String]): Array[Byte]

Converts a value of this key to JSON

Converts a value of this key to JSON

Attributes

Returns

UTF-8 encoded JSON

Inherited from:
KeyWithJsonCodec

Concrete fields

val 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.

Attributes

override val 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.

Attributes

val name: String

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

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

Attributes

val prefix: Seq[String]

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

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

Attributes

override val specificationLevel: SpecificationLevel

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

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

Attributes

Generated with