clikt-core/com.github.ajalt.clikt.output/Localization

Localization

interface Localization

Strings to use for help output and error messages

Functions

argumentsMetavar

open fun argumentsMetavar(): String

The placeholder that indicates where arguments may be present in the usage help output

argumentsTitle

open fun argumentsTitle(): String

The title for the arguments section of help output

badParameter

open fun badParameter(): String

Message for BadParameterValue

badParameterWithMessage

open fun badParameterWithMessage(message: String): String

Message for BadParameterValue

badParameterWithMessageAndParam

open fun badParameterWithMessageAndParam(paramName: String, message: String): String

Message for BadParameterValue

badParameterWithParam

open fun badParameterWithParam(paramName: String): String

Message for BadParameterValue

boolConversionError

open fun boolConversionError(value: String): String

Invalid value for a parameter of type Boolean

commandMetavar

open fun commandMetavar(): String

The placeholder that indicates where subcommands may be present in the usage help output

commandsTitle

open fun commandsTitle(): String

The title for the subcommands section of help output

countedOptionExceededLimit

open fun countedOptionExceededLimit(count: Int, limit: Int): String

A counted option was given more times than its limit

defaultMetavar

open fun defaultMetavar(): String

Metavar used for options with unspecified value type

extraArgumentMany

open fun extraArgumentMany(name: String, count: Int): String

More than one extra argument is present

extraArgumentOne

open fun extraArgumentOne(name: String): String

One extra argument is present

fileEndsWithSlash

open fun fileEndsWithSlash(): String

Error in message for InvalidFileFormat

fileMetavar

open fun fileMetavar(): String

Metavar used for options that take InputStream or OutputStream values

fileNotFound

open fun fileNotFound(filename: String): String

Message for FileNotFound

floatConversionError

open fun floatConversionError(value: String): String

Invalid value for a parameter of type Double or Float

floatMetavar

open fun floatMetavar(): String

Metavar used for options that take Float or Double values

helpOptionMessage

open fun helpOptionMessage(): String

The default message for the --help option.

helpTagDefault

open fun helpTagDefault(): String

Text rendered for parameters tagged with HelpFormatter.Tags.DEFAULT

helpTagRequired

open fun helpTagRequired(): String

Text rendered for parameters tagged with HelpFormatter.Tags.REQUIRED

incorrectArgumentValueCount

open fun incorrectArgumentValueCount(name: String, count: Int): String

Message for IncorrectArgumentValueCount

incorrectOptionValueCount

open fun incorrectOptionValueCount(name: String, count: Int): String

Message for IncorrectOptionValueCount

intConversionError

open fun intConversionError(value: String): String

Invalid value for a parameter of type Int or Long

intMetavar

open fun intMetavar(): String

Metavar used for options that take Int or Long values

invalidChoice

open fun invalidChoice(choice: String, choices: List<String>): String

Invalid value for choice parameter

invalidFileFormat

open fun invalidFileFormat(filename: String, message: String): String

open fun invalidFileFormat(filename: String, lineNumber: Int, message: String): String

Message for InvalidFileFormat

invalidFlagValueInFile

open fun invalidFlagValueInFile(name: String): String

Error message when reading flag option from a file

invalidGroupChoice

open fun invalidGroupChoice(value: String, choices: List<String>): String

ChoiceGroup value was invalid

missingArgument

open fun missingArgument(paramName: String): String

Message for MissingArgument

missingOption

open fun missingOption(paramName: String): String

Message for MissingOption

mutexGroupException

open fun mutexGroupException(name: String, others: List<String>): String

Message for MutuallyExclusiveGroupException

noSuchOption

open fun noSuchOption(name: String, possibilities: List<String>): String

Message for NoSuchOption

noSuchOptionWithSubCommandPossibility

open fun noSuchOptionWithSubCommandPossibility(name: String, subcommand: String): String

Message for NoSuchOption when a subcommand has an option with the same name

noSuchSubcommand

open fun noSuchSubcommand(name: String, possibilities: List<String>): String

Message for NoSuchSubcommand

optionsMetavar

open fun optionsMetavar(): String

The placeholder that indicates where options may be present in the usage help output

optionsTitle

open fun optionsTitle(): String

The title for the options section of help output

pathDoesNotExist

open fun pathDoesNotExist(pathType: String, path: String): String

Invalid path value given

pathIsDirectory

open fun pathIsDirectory(pathType: String, path: String): String

Invalid path value given

pathIsFile

open fun pathIsFile(pathType: String, path: String): String

Invalid path value given

pathIsNotReadable

open fun pathIsNotReadable(pathType: String, path: String): String

Invalid path value given

pathIsNotWritable

open fun pathIsNotWritable(pathType: String, path: String): String

Invalid path value given

pathIsSymlink

open fun pathIsSymlink(pathType: String, path: String): String

Invalid path value given

pathMetavar

open fun pathMetavar(): String

Metavar used for options that take File or Path values

pathTypeDirectory

open fun pathTypeDirectory(): String

The pathType parameter to pathDoesNotExist and other path* errors

pathTypeFile

open fun pathTypeFile(): String

The pathType parameter to pathDoesNotExist and other path* errors

pathTypeOther

open fun pathTypeOther(): String

The pathType parameter to pathDoesNotExist and other path* errors

rangeExceededBoth

open fun rangeExceededBoth(value: String, min: String, max: String): String

Invalid value falls outside range

rangeExceededMax

open fun rangeExceededMax(value: String, limit: String): String

Invalid value falls outside range

rangeExceededMin

open fun rangeExceededMin(value: String, limit: String): String

Invalid value falls outside range

requiredMutexOption

open fun requiredMutexOption(options: String): String

Required MutuallyExclusiveOptions was not provided

stringMetavar

open fun stringMetavar(): String

Metavar used for options that take String values

switchOptionEnvvar

open fun switchOptionEnvvar(): String

Error message when reading switch option from environment variable

unclosedQuote

open fun unclosedQuote(): String

Error in message for InvalidFileFormat

usageError

open fun usageError(): String

Prefix for any UsageError

usageTitle

open fun usageTitle(): String

The title for the usage section of help output