Package avail.tools.options

Types

Link copied to clipboard
class InvalidArgumentException(val keyword: String) : OptionProcessingException

Exception thrown during option processing upon discovery that an argument is invalid.

Link copied to clipboard
class MissingArgumentException(val keyword: String) : OptionProcessingException

Exception thrown during option processing upon discovery that a mandatory argument is missing.

Link copied to clipboard
interface Option<OptionKeyType : Enum<OptionKeyType>>

An Option comprises an enumerated type which defines the domain of the option, the keywords which parsers may use to identify the option, an end-user friendly description of the option, and an action that should be performed each time that the option is set.

Link copied to clipboard
open class OptionProcessingException : RuntimeException

Exception thrown during option processing.

Link copied to clipboard
class OptionProcessor<OptionKeyType : Enum<OptionKeyType>>

An OptionProcessor serves primarily to support command-line argument processing, but may occasionally prove useful in other circumstances.

Link copied to clipboard
class OptionProcessorFactory<OptionKeyType : Enum<OptionKeyType>>

An OptionProcessorFactory enables a client to dynamically specify and assemble an option processor. In particular, the factory allows a client to flexibly define a particular option processor while ignoring specification and evaluation order dependency. Validation is postponed until final assembly time, at which time a [ValidationException] will be thrown in the event of incorrect or incomplete specification; otherwise, the constructed option processor provably reflects the client specification.

Link copied to clipboard
class UnrecognizedKeywordException : OptionProcessingException

Exception thrown during option processing upon discovery of an unrecognized option keyword.

Link copied to clipboard
class ValidationException : RuntimeException

Exception thrown by the factory's validation process in the event that the client-specified option processor fails validation.