dev-java-time/dev.kordex.modules.dev.java.time/J8DurationConverter

J8DurationConverter

class J8DurationConverter(val longHelp: Boolean = true, val positiveOnly: Boolean = true, var validator: <Error class: unknown class><ChronoContainer> = null) : SingleConverter<ChronoContainer>

Argument converter for Java 8 Duration arguments.

For a coalescing version of this converter, see J8DurationCoalescingConverter. If you're using Time4J instead, see T4JDurationConverter.

Parameters

longHelp

Whether to send the user a long help message with specific information on how to specify durations.

positiveOnly

Whether a positive duration is required - true by default.

Constructors

J8DurationConverter

constructor(longHelp: Boolean = true, positiveOnly: Boolean = true, validator: <Error class: unknown class><ChronoContainer> = null)

Properties

argumentObj

open lateinit var argumentObj: Argument<*>

bot

open val bot: ExtensibleBot

builder

open lateinit var builder: ConverterBuilder<ChronoContainer>

errorType

open val errorType: Key?

kord

val kord: Kord

longHelp

val longHelp: Boolean = true

parsed

open lateinit override var parsed: ChronoContainer

parseSuccess

var parseSuccess: Boolean

positiveOnly

val positiveOnly: Boolean = true

required

open override val required: Boolean

showTypeInSignature

open val showTypeInSignature: Boolean

signatureType

open override val signatureType: Key

validator

open override var validator: <Error class: unknown class><ChronoContainer>

Functions

getErrorKey

open suspend fun getErrorKey(): Key

getErrorString

open suspend fun getErrorString(context: CommandContext): String

getKoin

open override fun getKoin(): Koin

getValue

operator fun getValue(thisRef: Arguments, property: KProperty<*>): ChronoContainer

handleError

open suspend fun handleError(t: Throwable, context: CommandContext): Key

mutate

open suspend fun mutate(context: CommandContext): ChronoContainer

parse

open suspend override fun parse(parser: StringParser?, context: CommandContext, named: String?): Boolean

parseOption

open suspend override fun parseOption(context: CommandContext, option: OptionValue<*>): Boolean

toDefaulting

open fun toDefaulting(defaultValue: ChronoContainer, outputError: Boolean, signatureType: Key?, showTypeInSignature: Boolean?, errorType: Key?, nestedValidator: Validator<ChronoContainer>): DefaultingConverter<ChronoContainer>

toList

open fun toList(required: Boolean, signatureType: Key?, showTypeInSignature: Boolean?, errorType: Key?, nestedValidator: Validator<List<ChronoContainer>>): ListConverter<ChronoContainer>

toOptional

open fun toOptional(signatureType: Key?, showTypeInSignature: Boolean?, errorType: Key?, outputError: Boolean, nestedValidator: Validator<ChronoContainer?>): OptionalConverter<ChronoContainer>

toSlashOption

open suspend override fun toSlashOption(arg: Argument<*>): OptionWrapper<StringChoiceBuilder>

validate

open suspend fun validate(context: CommandContext)

withBuilder

open fun withBuilder(builder: ConverterBuilder<ChronoContainer>): SingleConverter<ChronoContainer>