GraphMine

graphmine-core / io.github.sof3.graphmine.command.args / EnumArg

EnumArg

class EnumArg<E : Enum<E>> : CommandArg<E>

Accepts a value that names one of the constants in the enum class

Types

SymbolPolicy

enum class SymbolPolicy The policy to use for comparing symbols in enum names

Constructors

<init>

EnumArg(enumClass: KClass<E>) Accepts a value that names one of the constants in the enum class

Properties

ignoreCase	var ignoreCase: Boolean Match enum constant names case-insensitively.
symbolPolicy	var symbolPolicy: SymbolPolicy The policy for comparing symbols in enum names

Inherited Properties

default	var default: T? Sets the default value of the command. Implicitly sets optional to true (even if the set value is null)
optional	var optional: Boolean Whether the command arg can be skipped
value	lateinit var value: T The received value of the argument

Functions

parse

fun parse(parser: FormattedStringReader): E? Reads the next value in the parser into the value for the argument

Inherited Functions

accept	fun accept(parser: FormattedStringReader): Boolean Reads the next value in the parser into the value for the argument.
default	fun default(value: T): CommandArg<T> Sets the default value of the command. Implicitly sets optional to true (even if the set value is null)
provideDelegate	open fun provideDelegate(thisRef: Overload, property: KProperty<*>): ReadOnlyProperty<Overload, T>

This site is open source. Improve this page.