dev-time4j/dev.kordex.modules.dev.time4j/T4JDurationCoalescingConverter

T4JDurationCoalescingConverter

class T4JDurationCoalescingConverter(val longHelp: Boolean = true, shouldThrow: Boolean = false, var validator: <Error class: unknown class><Duration<IsoUnit>> = null) : CoalescingConverter<Duration<IsoUnit>>

Coalescing argument converter for Time4J Duration arguments.

This converter will take individual duration specifiers ("1w", "2y", "3d" etc) until it no longer can, and then combine them into a single Duration.

Parameters

longHelp

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

See also

coalescedT4jDuration
parseT4JDuration

Constructors

Link copied to clipboard
constructor(longHelp: Boolean = true, shouldThrow: Boolean = false, validator: <Error class: unknown class><Duration<IsoUnit>> = null)

Properties

Link copied to clipboard
open lateinit var argumentObj: Argument<*>
Link copied to clipboard
open val bot: ExtensibleBot
Link copied to clipboard
open lateinit var builder: CoalescingConverterBuilder<Duration<IsoUnit>>
Link copied to clipboard
open val errorType: Key?
Link copied to clipboard
val kord: Kord
Link copied to clipboard
val longHelp: Boolean = true
Link copied to clipboard
open lateinit override var parsed: Duration<IsoUnit>
Link copied to clipboard
Link copied to clipboard
open override val required: Boolean
Link copied to clipboard
open val shouldThrow: Boolean
Link copied to clipboard
Link copied to clipboard
open override val signatureType: Key
Link copied to clipboard
open override var validator: <Error class: unknown class><Duration<IsoUnit>>

Functions

Link copied to clipboard
open suspend fun getErrorKey(): Key
Link copied to clipboard
open suspend fun getErrorString(context: CommandContext): String
Link copied to clipboard
open override fun getKoin(): Koin
Link copied to clipboard
operator fun getValue(thisRef: Arguments, property: KProperty<*>): Duration<IsoUnit>
Link copied to clipboard
open suspend fun handleError(t: Throwable, context: CommandContext): Key
Link copied to clipboard
open suspend fun mutate(context: CommandContext): Duration<IsoUnit>
Link copied to clipboard
open suspend override fun parse(parser: StringParser?, context: CommandContext, named: List<String>?): Int
Link copied to clipboard
open suspend override fun parseOption(context: CommandContext, option: OptionValue<*>): Boolean
Link copied to clipboard
open fun toDefaulting(defaultValue: Duration<IsoUnit>, outputError: Boolean, signatureType: Key?, showTypeInSignature: Boolean?, errorType: Key?, nestedValidator: Validator<Duration<IsoUnit>>): DefaultingCoalescingConverter<Duration<IsoUnit>>
Link copied to clipboard
open fun toOptional(signatureType: Key?, showTypeInSignature: Boolean?, errorType: Key?, outputError: Boolean, nestedValidator: Validator<Duration<IsoUnit>?>): OptionalCoalescingConverter<Duration<IsoUnit>>
Link copied to clipboard
open suspend override fun toSlashOption(arg: Argument<*>): OptionWrapper<StringChoiceBuilder>
Link copied to clipboard
open suspend fun validate(context: CommandContext)
Link copied to clipboard
open fun withBuilder(builder: CoalescingConverterBuilder<Duration<IsoUnit>>): CoalescingConverter<Duration<IsoUnit>>