Localization

interface Localization

Strings to use for help output and error messages

Functions

Link copied to clipboard

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

Link copied to clipboard

The title for the arguments section of help output

Link copied to clipboard
open fun badParameter(): String

Message for BadParameterValue

Link copied to clipboard
Link copied to clipboard
open fun badParameterWithMessageAndParam(paramName: String, message: String): String

Message for BadParameterValue

Link copied to clipboard
open fun badParameterWithParam(paramName: String): String

Message for BadParameterValue

Link copied to clipboard

Invalid value for a parameter of type Boolean

Link copied to clipboard

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

Link copied to clipboard
open fun commandsTitle(): String

The title for the subcommands section of help output

Link copied to clipboard
open fun countedOptionExceededLimit(count: Int, limit: Int): String

A counted option was given more times than its limit

Link copied to clipboard

Metavar used for options with unspecified value type

Link copied to clipboard
open fun extraArgumentMany(name: String, count: Int): String

More than one extra argument is present

Link copied to clipboard
open fun extraArgumentOne(name: String): String

One extra argument is present

Link copied to clipboard

Error in message for InvalidFileFormat

Link copied to clipboard
open fun fileMetavar(): String

Metavar used for options that take InputStream or OutputStream values

Link copied to clipboard
open fun fileNotFound(filename: String): String

Message for FileNotFound

Link copied to clipboard

Invalid value for a parameter of type Double or Float

Link copied to clipboard
open fun floatMetavar(): String

Metavar used for options that take Float or Double values

Link copied to clipboard

The default message for the --help option.

Link copied to clipboard

Text rendered for parameters tagged with HelpFormatter.Tags.DEFAULT

Link copied to clipboard

Text rendered for parameters tagged with HelpFormatter.Tags.REQUIRED

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun intConversionError(value: String): String

Invalid value for a parameter of type Int or Long

Link copied to clipboard
open fun intMetavar(): String

Metavar used for options that take Int or Long values

Link copied to clipboard
open fun invalidChoice(choice: String, choices: List<String>): String

Invalid value for choice parameter

Link copied to clipboard
open fun invalidFileFormat(filename: String, message: String): String
open fun invalidFileFormat(filename: String, lineNumber: Int, message: String): String

Message for InvalidFileFormat

Link copied to clipboard

Error message when reading flag option from a file

Link copied to clipboard
open fun invalidGroupChoice(value: String, choices: List<String>): String

ChoiceGroup value was invalid

Link copied to clipboard
open fun missingArgument(paramName: String): String

Message for MissingArgument

Link copied to clipboard
open fun missingOption(paramName: String): String

Message for MissingOption

Link copied to clipboard
Link copied to clipboard
open fun noSuchOption(name: String, possibilities: List<String>): String

Message for NoSuchOption

Link copied to clipboard

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

Link copied to clipboard
open fun noSuchSubcommand(name: String, possibilities: List<String>): String

Message for NoSuchSubcommand

Link copied to clipboard

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

Link copied to clipboard
open fun optionsTitle(): String

The title for the options section of help output

Link copied to clipboard
open fun pathDoesNotExist(pathType: String, path: String): String

Invalid path value given

Link copied to clipboard
open fun pathIsDirectory(pathType: String, path: String): String

Invalid path value given

Link copied to clipboard
open fun pathIsFile(pathType: String, path: String): String

Invalid path value given

Link copied to clipboard
open fun pathIsNotReadable(pathType: String, path: String): String

Invalid path value given

Link copied to clipboard
open fun pathIsNotWritable(pathType: String, path: String): String

Invalid path value given

Link copied to clipboard
open fun pathIsSymlink(pathType: String, path: String): String

Invalid path value given

Link copied to clipboard
open fun pathMetavar(): String

Metavar used for options that take File or Path values

Link copied to clipboard

The pathType parameter to pathDoesNotExist and other path* errors

Link copied to clipboard
open fun pathTypeFile(): String

The pathType parameter to pathDoesNotExist and other path* errors

Link copied to clipboard
open fun pathTypeOther(): String

The pathType parameter to pathDoesNotExist and other path* errors

Link copied to clipboard
open fun rangeExceededBoth(value: String, min: String, max: String): String

Invalid value falls outside range

Link copied to clipboard
open fun rangeExceededMax(value: String, limit: String): String

Invalid value falls outside range

Link copied to clipboard
open fun rangeExceededMin(value: String, limit: String): String

Invalid value falls outside range

Link copied to clipboard
open fun requiredMutexOption(options: String): String

Required MutuallyExclusiveOptions was not provided

Link copied to clipboard
open fun stringMetavar(): String

Metavar used for options that take String values

Link copied to clipboard

Error message when reading switch option from environment variable

Link copied to clipboard
open fun unclosedQuote(): String

Error in message for InvalidFileFormat

Link copied to clipboard
open fun usageError(): String

Prefix for any UsageError

Link copied to clipboard
open fun usageTitle(): String

The title for the usage section of help output