Localization

interface Localization

Strings to use for help output and error messages

Functions

aborted
Link copied to clipboard
common
open fun aborted(): String
Abort was thrown
argumentsTitle
Link copied to clipboard
common
open fun argumentsTitle(): String
The title for the arguments section of help output
badParameter
Link copied to clipboard
common
open fun badParameter(): String
Message for BadParameterValue
badParameterWithMessage
Link copied to clipboard
common
open fun badParameterWithMessage(message: String): String
Message for BadParameterValue
badParameterWithMessageAndParam
Link copied to clipboard
common
open fun badParameterWithMessageAndParam(paramName: String, message: String): String
Message for BadParameterValue
badParameterWithParam
Link copied to clipboard
common
open fun badParameterWithParam(paramName: String): String
Message for BadParameterValue
boolConversionError
Link copied to clipboard
common
open fun boolConversionError(value: String): String
Invalid value for a parameter of type Boolean
commandMetavar
Link copied to clipboard
common
open fun commandMetavar(): String
The that indicates where subcommands may be present in the usage help output
commandsTitle
Link copied to clipboard
common
open fun commandsTitle(): String
The title for the subcommands section of help output
defaultMetavar
Link copied to clipboard
common
open fun defaultMetavar(): String
Metavar used for options with unspecified value type
extraArgumentMany
Link copied to clipboard
common
open fun extraArgumentMany(name: String, count: Int): String
More than one extra argument is present
extraArgumentOne
Link copied to clipboard
common
open fun extraArgumentOne(name: String): String
One extra argument is present
fileEndsWithSlash
Link copied to clipboard
common
open fun fileEndsWithSlash(): String
Error in message for InvalidFileFormat
fileMetavar
Link copied to clipboard
common
open fun fileMetavar(): String
Metavar used for options that take InputStream or OutputStream values
fileNotFound
Link copied to clipboard
common
open fun fileNotFound(filename: String): String
Message for FileNotFound
floatConversionError
Link copied to clipboard
common
open fun floatConversionError(value: String): String
Invalid value for a parameter of type Double or Float
floatMetavar
Link copied to clipboard
common
open fun floatMetavar(): String
Metavar used for options that take Float or Double values
helpOptionMessage
Link copied to clipboard
common
open fun helpOptionMessage(): String
The default message for the --help option.
helpTagDefault
Link copied to clipboard
common
open fun helpTagDefault(): String
Text rendered for parameters tagged with HelpFormatter.Tags.DEFAULT
helpTagRequired
Link copied to clipboard
common
open fun helpTagRequired(): String
Text rendered for parameters tagged with HelpFormatter.Tags.REQUIRED
incorrectArgumentValueCount
Link copied to clipboard
common
open fun incorrectArgumentValueCount(name: String, count: Int): String
incorrectOptionValueCount
Link copied to clipboard
common
open fun incorrectOptionValueCount(name: String, count: Int): String
intConversionError
Link copied to clipboard
common
open fun intConversionError(value: String): String
Invalid value for a parameter of type Int or Long
intMetavar
Link copied to clipboard
common
open fun intMetavar(): String
Metavar used for options that take Int or Long values
invalidChoice
Link copied to clipboard
common
open fun invalidChoice(choice: String, choices: List<String>): String
Invalid value for choice parameter
invalidFileFormat
Link copied to clipboard
common
open fun invalidFileFormat(filename: String, message: String): String
Message for InvalidFileFormat
open fun invalidFileFormat(filename: String, lineNumber: Int, message: String): String
Message for InvalidFileFormat
invalidFlagValueInFile
Link copied to clipboard
common
open fun invalidFlagValueInFile(name: String): String
Error message when reading flag option from a file
invalidGroupChoice
Link copied to clipboard
common
open fun invalidGroupChoice(value: String, choices: List<String>): String
ChoiceGroup value was invalid
missingArgument
Link copied to clipboard
common
open fun missingArgument(paramName: String): String
Message for MissingArgument
missingOption
Link copied to clipboard
common
open fun missingOption(paramName: String): String
Message for MissingOption
mutexGroupException
Link copied to clipboard
common
open fun mutexGroupException(name: String, others: List<String>): String
noSuchOption
Link copied to clipboard
common
open fun noSuchOption(name: String, possibilities: List<String>): String
Message for NoSuchOption
noSuchSubcommand
Link copied to clipboard
common
open fun noSuchSubcommand(name: String, possibilities: List<String>): String
Message for NoSuchSubcommand
optionsMetavar
Link copied to clipboard
common
open fun optionsMetavar(): String
The that indicates where options may be present in the usage help output
optionsTitle
Link copied to clipboard
common
open fun optionsTitle(): String
The title for the options section of help output
pathDoesNotExist
Link copied to clipboard
common
open fun pathDoesNotExist(pathType: String, path: String): String
Invalid path type
pathIsDirectory
Link copied to clipboard
common
open fun pathIsDirectory(pathType: String, path: String): String
Invalid path type
pathIsFile
Link copied to clipboard
common
open fun pathIsFile(pathType: String, path: String): String
Invalid path type
pathIsNotReadable
Link copied to clipboard
common
open fun pathIsNotReadable(pathType: String, path: String): String
Invalid path type
pathIsNotWritable
Link copied to clipboard
common
open fun pathIsNotWritable(pathType: String, path: String): String
Invalid path type
pathIsSymlink
Link copied to clipboard
common
open fun pathIsSymlink(pathType: String, path: String): String
Invalid path type
pathMetavar
Link copied to clipboard
common
open fun pathMetavar(): String
Metavar used for options that take File or Path values
pathTypeDirectory
Link copied to clipboard
common
open fun pathTypeDirectory(): String
The pathType parameter to pathDoesNotExist and other path* errors
pathTypeFile
Link copied to clipboard
common
open fun pathTypeFile(): String
The pathType parameter to pathDoesNotExist and other path* errors
pathTypeOther
Link copied to clipboard
common
open fun pathTypeOther(): String
The pathType parameter to pathDoesNotExist and other path* errors
rangeExceededBoth
Link copied to clipboard
common
open fun rangeExceededBoth(value: String, min: String, max: String): String
Invalid value falls outside range
rangeExceededMax
Link copied to clipboard
common
open fun rangeExceededMax(value: String, limit: String): String
Invalid value falls outside range
rangeExceededMin
Link copied to clipboard
common
open fun rangeExceededMin(value: String, limit: String): String
Invalid value falls outside range
requiredMutexOption
Link copied to clipboard
common
open fun requiredMutexOption(options: String): String
Required MutuallyExclusiveOptions was not provided
stringMetavar
Link copied to clipboard
common
open fun stringMetavar(): String
Metavar used for options that take String values
switchOptionEnvvar
Link copied to clipboard
common
open fun switchOptionEnvvar(): String
Error message when reading switch option from environment variable
unclosedQuote
Link copied to clipboard
common
open fun unclosedQuote(): String
Error in message for InvalidFileFormat
usageError
Link copied to clipboard
common
open fun usageError(message: String): String
Prefix for any UsageError
usageTitle
Link copied to clipboard
common
open fun usageTitle(): String
The title for the usage section of help output