argot-annotations/org.draftcode.argot.annotations

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Argument(val help: String = "")

Declares a positional argument on a Command constructor parameter, named after the parameter.

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Command(val name: String = "", val description: String = "")

Marks a class whose primary-constructor parameters declare a command-line interface.

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Flag(val names: Array<String> = [], val help: String = "")

Declares a boolean flag on a Command constructor parameter.

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Option(val names: Array<String> = [], val help: String = "", val default: String = NO_DEFAULT)

Declares a value-bearing named option on a Command constructor parameter.

Properties

const val NO_DEFAULT: String

Sentinel for Option.default meaning "no default supplied" (annotation arguments cannot be null). Used by the processor; not intended for direct use.