# Index

A B C D E F G H I L M N O P Q R S T V W
All Classes and Interfaces|All Packages|Serialized Form

## A

adapt(T, Function) - Static method in exception class com.io7m.quarrel.core.QException
  Adapt a generic exception to this exception type.
addCommand(QCommandType) - Method in interface com.io7m.quarrel.core.QApplicationBuilderType
  Add a command.
addCommand(QCommandType) - Method in interface com.io7m.quarrel.core.QApplicationCommandGroupBuilderType
  Add a command within this group.
allowAtSyntax(boolean) - Method in interface com.io7m.quarrel.core.QApplicationBuilderType
  Enable or disable @ syntax processing.
applicationId() - Method in record class com.io7m.quarrel.core.QApplicationMetadata
  Returns the value of the `applicationId` record component.
applicationName() - Method in record class com.io7m.quarrel.core.QApplicationMetadata
  Returns the value of the `applicationName` record component.
applicationResources() - Method in class com.io7m.quarrel.core.QApplication
applicationResources() - Method in interface com.io7m.quarrel.core.QApplicationType
applicationResources() - Method in record class com.io7m.quarrel.core.QCommandParserConfiguration
  Returns the value of the `applicationResources` record component.
attributes() - Method in exception class com.io7m.quarrel.core.QException

## B

badName() - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionErrorDoesNotExist
  Returns the value of the `badName` record component.
build() - Method in interface com.io7m.quarrel.core.QApplicationBuilderType
build() - Method in record class com.io7m.quarrel.core.QApplicationMetadata
  Returns the value of the `build` record component.
builder(QApplicationMetadata) - Static method in class com.io7m.quarrel.core.QApplication
  Create a new application builder.

## C

cardinalityMaximum() - Method in record class com.io7m.quarrel.core.QParameterNamed01
cardinalityMaximum() - Method in record class com.io7m.quarrel.core.QParameterNamed0N
cardinalityMaximum() - Method in record class com.io7m.quarrel.core.QParameterNamed1
cardinalityMaximum() - Method in record class com.io7m.quarrel.core.QParameterNamed1N
cardinalityMaximum() - Method in interface com.io7m.quarrel.core.QParameterNamedType
cardinalityMinimum() - Method in record class com.io7m.quarrel.core.QParameterNamed01
cardinalityMinimum() - Method in record class com.io7m.quarrel.core.QParameterNamed0N
cardinalityMinimum() - Method in record class com.io7m.quarrel.core.QParameterNamed1
cardinalityMinimum() - Method in record class com.io7m.quarrel.core.QParameterNamed1N
cardinalityMinimum() - Method in interface com.io7m.quarrel.core.QParameterNamedType
checkOK(String) - Static method in class com.io7m.quarrel.core.QNames
  Check that the given name is valid.
com.io7m.quarrel.core - package com.io7m.quarrel.core
  Command-line argument parser (Core)
com.io7m.quarrel.core.converters - package com.io7m.quarrel.core.converters
  Command-line argument parser (Core [Value converters])
com.io7m.quarrel.core.internal - package com.io7m.quarrel.core.internal
  Command-line argument parser (Core [internals])
com.io7m.quarrel.example - package com.io7m.quarrel.example
  Command-line argument parser (Example)
com.io7m.quarrel.ext.xstructural - package com.io7m.quarrel.ext.xstructural
  Command-line argument parser (xstructural extension)
command() - Method in class com.io7m.quarrel.core.internal.QCommandContext
command() - Method in interface com.io7m.quarrel.core.QCommandContextType
command() - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionOKCommand
  Returns the value of the `command` record component.
commandTree() - Method in class com.io7m.quarrel.core.internal.QCommandContext
commandTree() - Method in class com.io7m.quarrel.core.QApplication
commandTree() - Method in interface com.io7m.quarrel.core.QApplicationType
commandTree() - Method in interface com.io7m.quarrel.core.QCommandContextType
commandTree() - Method in interface com.io7m.quarrel.core.QCommandGroupType
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCBigDecimal
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCBigInteger
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCBoolean
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCDouble
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCDuration
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCEnum
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCFloat
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCInetAddress
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCInteger
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCLong
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCOffsetDateTime
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCPath
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCPattern
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCString
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCURI
convertedClass() - Method in class com.io7m.quarrel.core.converters.QVCUUID
convertedClass() - Method in interface com.io7m.quarrel.core.QValueConverterType
converterFor(Class) - Method in class com.io7m.quarrel.core.QValueConverterDirectory
converterFor(Class) - Method in interface com.io7m.quarrel.core.QValueConverterDirectoryType
converters() - Method in record class com.io7m.quarrel.core.QCommandParserConfiguration
  Returns the value of the `converters` record component.
converters() - Method in class com.io7m.quarrel.core.QValueConverterDirectory
converters() - Method in interface com.io7m.quarrel.core.QValueConverterDirectoryType
convertFromString(String) - Method in class com.io7m.quarrel.core.converters.QVCAbstract
convertFromString(String) - Method in class com.io7m.quarrel.core.converters.QVCEnum
convertFromString(String) - Method in interface com.io7m.quarrel.core.QValueConverterType
  Convert the given string to a value of type `T`.
convertToString(Boolean) - Method in class com.io7m.quarrel.core.converters.QVCBoolean
convertToString(Double) - Method in class com.io7m.quarrel.core.converters.QVCDouble
convertToString(Float) - Method in class com.io7m.quarrel.core.converters.QVCFloat
convertToString(Integer) - Method in class com.io7m.quarrel.core.converters.QVCInteger
convertToString(Long) - Method in class com.io7m.quarrel.core.converters.QVCLong
convertToString(String) - Method in class com.io7m.quarrel.core.converters.QVCString
convertToString(BigDecimal) - Method in class com.io7m.quarrel.core.converters.QVCBigDecimal
convertToString(BigInteger) - Method in class com.io7m.quarrel.core.converters.QVCBigInteger
convertToString(InetAddress) - Method in class com.io7m.quarrel.core.converters.QVCInetAddress
convertToString(URI) - Method in class com.io7m.quarrel.core.converters.QVCURI
convertToString(Path) - Method in class com.io7m.quarrel.core.converters.QVCPath
convertToString(Duration) - Method in class com.io7m.quarrel.core.converters.QVCDuration
convertToString(OffsetDateTime) - Method in class com.io7m.quarrel.core.converters.QVCOffsetDateTime
convertToString(Pattern) - Method in class com.io7m.quarrel.core.converters.QVCPattern
convertToString(UUID) - Method in class com.io7m.quarrel.core.converters.QVCUUID
convertToString(T) - Method in class com.io7m.quarrel.core.converters.QVCEnum
convertToString(T) - Method in interface com.io7m.quarrel.core.QValueConverterType
  Convert a value of `T` to a string.
core() - Static method in class com.io7m.quarrel.core.QValueConverterDirectory
create(QCommandParserConfiguration) - Method in interface com.io7m.quarrel.core.QCommandParserFactoryType
  Create a command parser.
create(QCommandParserConfiguration) - Method in class com.io7m.quarrel.core.QCommandParsers
create(Locale) - Static method in class com.io7m.quarrel.core.QLocalization
  Create a localizer without application-specific resources.
create(Locale, ResourceBundle) - Static method in class com.io7m.quarrel.core.QLocalization
  Create a localizer.
create(ResourceBundle, ResourceBundle) - Static method in class com.io7m.quarrel.core.QLocalization
  Create a localizer.
createCommandGroup(QCommandMetadata) - Method in interface com.io7m.quarrel.core.QApplicationBuilderType
  Create a new command group.
createCommandGroup(QCommandMetadata) - Method in interface com.io7m.quarrel.core.QApplicationCommandGroupBuilderType
  Create a command group within this group.

## D

defaultValue() - Method in record class com.io7m.quarrel.core.QParameterNamed01
  Returns the value of the `defaultValue` record component.
defaultValue() - Method in record class com.io7m.quarrel.core.QParameterNamed0N
  Returns the value of the `defaultValue` record component.
defaultValue() - Method in record class com.io7m.quarrel.core.QParameterNamed1
  Returns the value of the `defaultValue` record component.
defaultValue() - Method in record class com.io7m.quarrel.core.QParameterNamed1N
  Returns the value of the `defaultValue` record component.
description() - Method in record class com.io7m.quarrel.core.QParameterNamed01
  Returns the value of the `description` record component.
description() - Method in record class com.io7m.quarrel.core.QParameterNamed0N
  Returns the value of the `description` record component.
description() - Method in record class com.io7m.quarrel.core.QParameterNamed1
  Returns the value of the `description` record component.
description() - Method in record class com.io7m.quarrel.core.QParameterNamed1N
  Returns the value of the `description` record component.
description() - Method in record class com.io7m.quarrel.core.QParameterPositional
  Returns the value of the `description` record component.
description() - Method in interface com.io7m.quarrel.core.QParameterType

## E

empty() - Static method in class com.io7m.quarrel.core.QValueConverterDirectory
emptyResources() - Static method in class com.io7m.quarrel.core.QCommandParsers
equals(Object) - Method in record class com.io7m.quarrel.core.QApplicationMetadata
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QCommandMetadata
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QCommandParserConfiguration
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionErrorDoesNotExist
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionOKCommand
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionOKGroup
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QParameterNamed01
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QParameterNamed0N
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QParameterNamed1
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QParameterNamed1N
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QParameterPositional
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QParametersPositionalAny
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QParametersPositionalNone
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QParametersPositionalTyped
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QStringType.QConstant
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.io7m.quarrel.core.QStringType.QLocalize
  Indicates whether some other object is "equal to" this one.
errorCode() - Method in exception class com.io7m.quarrel.core.QException
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCBigDecimal
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCBigInteger
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCBoolean
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCDouble
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCDuration
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCEnum
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCFloat
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCInetAddress
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCInteger
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCLong
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCOffsetDateTime
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCPath
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCPattern
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCString
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCURI
exampleValue() - Method in class com.io7m.quarrel.core.converters.QVCUUID
exampleValue() - Method in interface com.io7m.quarrel.core.QValueConverterType
ExCat - Class in com.io7m.quarrel.example
  An example command.
ExCat() - Constructor for class com.io7m.quarrel.example.ExCat
  An example command.
exception() - Method in exception class com.io7m.quarrel.core.QException
ExCmd0 - Class in com.io7m.quarrel.example
  An example command.
ExCmd0() - Constructor for class com.io7m.quarrel.example.ExCmd0
  An example command.
ExCmd1 - Class in com.io7m.quarrel.example
  An example command.
ExCmd1() - Constructor for class com.io7m.quarrel.example.ExCmd1
  An example command.
ExCow - Class in com.io7m.quarrel.example
  An example command.
ExCow() - Constructor for class com.io7m.quarrel.example.ExCow
  An example command.
ExDog - Class in com.io7m.quarrel.example
  An example command.
ExDog() - Constructor for class com.io7m.quarrel.example.ExDog
  An example command.
execute() - Method in class com.io7m.quarrel.core.internal.QCommandContext
execute() - Method in interface com.io7m.quarrel.core.QCommandContextType
  Execute the command.
execute(SortedMap, PrintWriter, QCommandType, List) - Method in class com.io7m.quarrel.core.internal.QCommandParser
execute(SortedMap, PrintWriter, QCommandType, List) - Method in interface com.io7m.quarrel.core.QCommandParserType
  Parse arguments for the given command.
ExEverything - Class in com.io7m.quarrel.example
  An example command.
ExEverything() - Constructor for class com.io7m.quarrel.example.ExEverything
  An example command.
exitCode() - Method in enum class com.io7m.quarrel.core.QCommandStatus
  Determine the exit code for this status.
exitCode() - Method in class com.io7m.quarrel.example.Main
ExMeta - Class in com.io7m.quarrel.example
  The meta command.
ExMeta() - Constructor for class com.io7m.quarrel.example.ExMeta
  The meta command.
ExStrings - Class in com.io7m.quarrel.example
  The string resources.
ExStrings(Locale) - Constructor for class com.io7m.quarrel.example.ExStrings
  The string resources.
extraErrors() - Method in exception class com.io7m.quarrel.core.QException

## F

FAILURE - Enum constant in enum class com.io7m.quarrel.core.QCommandStatus
  The command failed.
format(QLocalizationType, SStructuredErrorType, Consumer) - Static method in class com.io7m.quarrel.core.QErrorFormatting
  Format the given error, passing the formatted message to the given consumer.
format(QStringType, Object...) - Method in class com.io7m.quarrel.core.internal.QCommandContext
format(QStringType, Object...) - Method in class com.io7m.quarrel.core.QApplication
format(QStringType, Object...) - Method in class com.io7m.quarrel.core.QLocalization
format(QStringType, Object...) - Method in interface com.io7m.quarrel.core.QLocalizationType
  Localize and format the given string.
formatCommand(QValueConverterDirectoryType, QLocalizationType, String, PrintWriter, QCommandType) - Static method in class com.io7m.quarrel.core.QCommandHelpFormatting
  Format a help message for the given command to the given output.
formatGroup(QValueConverterDirectoryType, QLocalizationType, String, PrintWriter, QCommandGroupType, List) - Static method in class com.io7m.quarrel.core.QCommandHelpFormatting
  Format a help message for the given group to the given output.

## G

get() - Static method in class com.io7m.quarrel.core.converters.QVCBigDecimal
get() - Static method in class com.io7m.quarrel.core.converters.QVCBigInteger
get() - Static method in class com.io7m.quarrel.core.converters.QVCBoolean
get() - Static method in class com.io7m.quarrel.core.converters.QVCDouble
get() - Static method in class com.io7m.quarrel.core.converters.QVCDuration
get() - Static method in class com.io7m.quarrel.core.converters.QVCFloat
get() - Static method in class com.io7m.quarrel.core.converters.QVCInetAddress
get() - Static method in class com.io7m.quarrel.core.converters.QVCInteger
get() - Static method in class com.io7m.quarrel.core.converters.QVCLong
get() - Static method in class com.io7m.quarrel.core.converters.QVCOffsetDateTime
get() - Static method in class com.io7m.quarrel.core.converters.QVCPath
get() - Static method in class com.io7m.quarrel.core.converters.QVCPattern
get() - Static method in class com.io7m.quarrel.core.converters.QVCString
get() - Static method in class com.io7m.quarrel.core.converters.QVCURI
get() - Static method in class com.io7m.quarrel.core.converters.QVCUUID
getKeys() - Method in class com.io7m.quarrel.core.internal.QEmptyResources

## H

handleGetObject(String) - Method in class com.io7m.quarrel.core.internal.QEmptyResources
hashCode() - Method in record class com.io7m.quarrel.core.QApplicationMetadata
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QCommandMetadata
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QCommandParserConfiguration
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionErrorDoesNotExist
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionOKCommand
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionOKGroup
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QParameterNamed01
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QParameterNamed0N
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QParameterNamed1
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QParameterNamed1N
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QParameterPositional
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QParametersPositionalAny
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QParametersPositionalNone
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QParametersPositionalTyped
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QStringType.QConstant
  Returns a hash code value for this object.
hashCode() - Method in record class com.io7m.quarrel.core.QStringType.QLocalize
  Returns a hash code value for this object.

## I

id() - Method in record class com.io7m.quarrel.core.QStringType.QLocalize
  Returns the value of the `id` record component.
internalResources() - Method in class com.io7m.quarrel.core.QApplication
internalResources() - Method in interface com.io7m.quarrel.core.QApplicationType
isHidden() - Method in interface com.io7m.quarrel.core.QCommandOrGroupType
isHidden() - Method in class com.io7m.quarrel.ext.xstructural.QCommandXS

## L

localize(QStringType) - Method in class com.io7m.quarrel.core.internal.QCommandContext
localize(QStringType) - Method in class com.io7m.quarrel.core.QApplication
localize(QStringType) - Method in class com.io7m.quarrel.core.QLocalization
localize(QStringType) - Method in interface com.io7m.quarrel.core.QLocalizationType
  Localize the given string.
longDescription() - Method in record class com.io7m.quarrel.core.QCommandMetadata
  Returns the value of the `longDescription` record component.

## M

main(String[]) - Static method in class com.io7m.quarrel.example.Main
  The main entry point.
Main - Class in com.io7m.quarrel.example
  The main program.
Main(String[]) - Constructor for class com.io7m.quarrel.example.Main
  The main entry point.
mainExitless(String[]) - Static method in class com.io7m.quarrel.example.Main
  The main (exitless) entry point.
metadata() - Method in class com.io7m.quarrel.core.internal.QCommandApplicationUsage
metadata() - Method in class com.io7m.quarrel.core.internal.QCommandHelp
metadata() - Method in class com.io7m.quarrel.core.internal.QCommandVersion
metadata() - Method in class com.io7m.quarrel.core.QApplication
metadata() - Method in interface com.io7m.quarrel.core.QApplicationType
metadata() - Method in interface com.io7m.quarrel.core.QCommandOrGroupType
metadata() - Method in class com.io7m.quarrel.example.ExCat
metadata() - Method in class com.io7m.quarrel.example.ExCmd0
metadata() - Method in class com.io7m.quarrel.example.ExCmd1
metadata() - Method in class com.io7m.quarrel.example.ExCow
metadata() - Method in class com.io7m.quarrel.example.ExDog
metadata() - Method in class com.io7m.quarrel.example.ExEverything
metadata() - Method in class com.io7m.quarrel.example.ExMeta
metadata() - Method in class com.io7m.quarrel.ext.xstructural.QCommandXS

## N

name() - Method in record class com.io7m.quarrel.core.QCommandMetadata
  Returns the value of the `name` record component.
name() - Method in record class com.io7m.quarrel.core.QParameterNamed01
  Returns the value of the `name` record component.
name() - Method in record class com.io7m.quarrel.core.QParameterNamed0N
  Returns the value of the `name` record component.
name() - Method in record class com.io7m.quarrel.core.QParameterNamed1
  Returns the value of the `name` record component.
name() - Method in record class com.io7m.quarrel.core.QParameterNamed1N
  Returns the value of the `name` record component.
name() - Method in record class com.io7m.quarrel.core.QParameterPositional
  Returns the value of the `name` record component.
name() - Method in interface com.io7m.quarrel.core.QParameterType
nameAlternatives() - Method in record class com.io7m.quarrel.core.QParameterNamed01
  Returns the value of the `nameAlternatives` record component.
nameAlternatives() - Method in record class com.io7m.quarrel.core.QParameterNamed0N
  Returns the value of the `nameAlternatives` record component.
nameAlternatives() - Method in record class com.io7m.quarrel.core.QParameterNamed1
  Returns the value of the `nameAlternatives` record component.
nameAlternatives() - Method in record class com.io7m.quarrel.core.QParameterNamed1N
  Returns the value of the `nameAlternatives` record component.
nameAlternatives() - Method in interface com.io7m.quarrel.core.QParameterNamedType

## O

onExecute(QCommandContextType) - Method in class com.io7m.quarrel.core.internal.QCommandApplicationUsage
onExecute(QCommandContextType) - Method in class com.io7m.quarrel.core.internal.QCommandHelp
onExecute(QCommandContextType) - Method in class com.io7m.quarrel.core.internal.QCommandVersion
onExecute(QCommandContextType) - Method in interface com.io7m.quarrel.core.QCommandType
  Execute the command.
onExecute(QCommandContextType) - Method in class com.io7m.quarrel.example.ExCat
onExecute(QCommandContextType) - Method in class com.io7m.quarrel.example.ExCmd0
onExecute(QCommandContextType) - Method in class com.io7m.quarrel.example.ExCmd1
onExecute(QCommandContextType) - Method in class com.io7m.quarrel.example.ExCow
onExecute(QCommandContextType) - Method in class com.io7m.quarrel.example.ExDog
onExecute(QCommandContextType) - Method in class com.io7m.quarrel.example.ExEverything
onExecute(QCommandContextType) - Method in class com.io7m.quarrel.example.ExMeta
onExecute(QCommandContextType) - Method in class com.io7m.quarrel.ext.xstructural.QCommandXS
onListNamedParameters() - Method in class com.io7m.quarrel.core.internal.QCommandApplicationUsage
onListNamedParameters() - Method in class com.io7m.quarrel.core.internal.QCommandHelp
onListNamedParameters() - Method in class com.io7m.quarrel.core.internal.QCommandVersion
onListNamedParameters() - Method in interface com.io7m.quarrel.core.QCommandType
onListNamedParameters() - Method in class com.io7m.quarrel.example.ExCat
onListNamedParameters() - Method in class com.io7m.quarrel.example.ExCmd0
onListNamedParameters() - Method in class com.io7m.quarrel.example.ExCmd1
onListNamedParameters() - Method in class com.io7m.quarrel.example.ExCow
onListNamedParameters() - Method in class com.io7m.quarrel.example.ExDog
onListNamedParameters() - Method in class com.io7m.quarrel.example.ExEverything
onListNamedParameters() - Method in class com.io7m.quarrel.example.ExMeta
onListNamedParameters() - Method in class com.io7m.quarrel.ext.xstructural.QCommandXS
onListPositionalParameters() - Method in class com.io7m.quarrel.core.internal.QCommandApplicationUsage
onListPositionalParameters() - Method in class com.io7m.quarrel.core.internal.QCommandHelp
onListPositionalParameters() - Method in class com.io7m.quarrel.core.internal.QCommandVersion
onListPositionalParameters() - Method in interface com.io7m.quarrel.core.QCommandType
onListPositionalParameters() - Method in class com.io7m.quarrel.example.ExCat
onListPositionalParameters() - Method in class com.io7m.quarrel.example.ExCmd0
onListPositionalParameters() - Method in class com.io7m.quarrel.example.ExCmd1
onListPositionalParameters() - Method in class com.io7m.quarrel.example.ExCow
onListPositionalParameters() - Method in class com.io7m.quarrel.example.ExDog
onListPositionalParameters() - Method in class com.io7m.quarrel.example.ExEverything
onListPositionalParameters() - Method in class com.io7m.quarrel.example.ExMeta
onListPositionalParameters() - Method in class com.io7m.quarrel.ext.xstructural.QCommandXS
output() - Method in class com.io7m.quarrel.core.internal.QCommandContext
output() - Method in interface com.io7m.quarrel.core.QCommandContextType

## P

parameters() - Method in record class com.io7m.quarrel.core.QParametersPositionalTyped
  Returns the value of the `parameters` record component.
parametersPositionalRaw() - Method in class com.io7m.quarrel.core.internal.QCommandContext
parametersPositionalRaw() - Method in interface com.io7m.quarrel.core.QCommandContextType
parameterValue(QParameterNamed01) - Method in class com.io7m.quarrel.core.internal.QCommandContext
parameterValue(QParameterNamed01) - Method in interface com.io7m.quarrel.core.QCommandContextType
parameterValue(QParameterNamed1) - Method in class com.io7m.quarrel.core.internal.QCommandContext
parameterValue(QParameterNamed1) - Method in interface com.io7m.quarrel.core.QCommandContextType
parameterValue(QParameterPositional) - Method in class com.io7m.quarrel.core.internal.QCommandContext
parameterValue(QParameterPositional) - Method in interface com.io7m.quarrel.core.QCommandContextType
parameterValueRequireNow(QParameterNamed01) - Method in class com.io7m.quarrel.core.internal.QCommandContext
parameterValueRequireNow(QParameterNamed01) - Method in interface com.io7m.quarrel.core.QCommandContextType
parameterValues(QParameterNamed0N) - Method in class com.io7m.quarrel.core.internal.QCommandContext
parameterValues(QParameterNamed0N) - Method in interface com.io7m.quarrel.core.QCommandContextType
parameterValues(QParameterNamed1N) - Method in class com.io7m.quarrel.core.internal.QCommandContext
parameterValues(QParameterNamed1N) - Method in interface com.io7m.quarrel.core.QCommandContextType
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCAbstract
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCBigDecimal
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCBigInteger
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCBoolean
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCDouble
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCDuration
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCFloat
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCInetAddress
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCInteger
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCLong
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCOffsetDateTime
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCPath
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCPattern
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCString
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCURI
parse(String) - Method in class com.io7m.quarrel.core.converters.QVCUUID
parse(List) - Method in class com.io7m.quarrel.core.QApplication
parse(List) - Method in interface com.io7m.quarrel.core.QApplicationType
  Parse the given command line arguments, returning an appropriate command context for execution.
path() - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionErrorDoesNotExist
  Returns the value of the `path` record component.
path() - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionOKCommand
  Returns the value of the `path` record component.
path() - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionOKGroup
  Returns the value of the `path` record component.

## Q

QApplication - Class in com.io7m.quarrel.core
  The default application configuration.
QApplicationBuilderType - Interface in com.io7m.quarrel.core
  An application builder.
QApplicationCommandGroupBuilderType - Interface in com.io7m.quarrel.core
  A builder for a command group.
QApplicationMetadata - Record Class in com.io7m.quarrel.core
  The application metadata.
QApplicationMetadata(String, String, String, String, String, Optional) - Constructor for record class com.io7m.quarrel.core.QApplicationMetadata
  The application metadata.
QApplicationType - Interface in com.io7m.quarrel.core
  An application.
QCommandApplicationUsage - Class in com.io7m.quarrel.core.internal
  The anonymous application usage command executed when no arguments are provided.
QCommandApplicationUsage(QApplicationType) - Constructor for class com.io7m.quarrel.core.internal.QCommandApplicationUsage
  The anonymous application usage command executed when no arguments are provided.
QCommandContext - Class in com.io7m.quarrel.core.internal
  A basic command context implementation.
QCommandContext(SortedMap, QValueConverterDirectoryType, PrintWriter, QCommandType, QLocalizationType, Map, QParametersPositionalType, List, List) - Constructor for class com.io7m.quarrel.core.internal.QCommandContext
  A basic command context implementation.
QCommandContextType - Interface in com.io7m.quarrel.core
  The context of execution for a command.
QCommandGroupType - Interface in com.io7m.quarrel.core
  A named group of commands.
QCommandHelp - Class in com.io7m.quarrel.core.internal
  The help command.
QCommandHelp(String, Map) - Constructor for class com.io7m.quarrel.core.internal.QCommandHelp
  The help command.
QCommandHelpFormatting - Class in com.io7m.quarrel.core
  Standard functions to format help messages.
QCommandMetadata - Record Class in com.io7m.quarrel.core
  The metadata for a command.
QCommandMetadata(String, QStringType, Optional) - Constructor for record class com.io7m.quarrel.core.QCommandMetadata
  The metadata for a command.
QCommandOrGroupType - Interface in com.io7m.quarrel.core
  A command, or a group of commands.
QCommandParser - Class in com.io7m.quarrel.core.internal
  The command parser.
QCommandParser(QCommandParserConfiguration, QStrings) - Constructor for class com.io7m.quarrel.core.internal.QCommandParser
  The command parser.
QCommandParserConfiguration - Record Class in com.io7m.quarrel.core
  The command parser configuration.
QCommandParserConfiguration(QValueConverterDirectoryType, ResourceBundle) - Constructor for record class com.io7m.quarrel.core.QCommandParserConfiguration
  The command parser configuration.
QCommandParserFactoryType - Interface in com.io7m.quarrel.core
  A factory of command parsers.
QCommandParsers - Class in com.io7m.quarrel.core
  The default factory of command parsers.
QCommandParsers() - Constructor for class com.io7m.quarrel.core.QCommandParsers
  The default factory of command parsers.
QCommandParserType - Interface in com.io7m.quarrel.core
  A command parser.
QCommandStatus - Enum Class in com.io7m.quarrel.core
  The result of executing a command.
QCommandTreeResolver - Class in com.io7m.quarrel.core
  The function to resolve commands or groups from a command tree.
QCommandTreeResolver.QResolutionErrorDoesNotExist - Record Class in com.io7m.quarrel.core
  The targeted object does not exist.
QCommandTreeResolver.QResolutionOKCommand - Record Class in com.io7m.quarrel.core
  The targeted object exists and is a command.
QCommandTreeResolver.QResolutionOKGroup - Record Class in com.io7m.quarrel.core
  The targeted object exists and is a group.
QCommandTreeResolver.QResolutionRoot - Enum Class in com.io7m.quarrel.core
  The targeted object is the root.
QCommandTreeResolver.QResolutionType - Interface in com.io7m.quarrel.core
  The type of resolutions.
QCommandType - Interface in com.io7m.quarrel.core
  The interface implemented by commands.
QCommandVersion - Class in com.io7m.quarrel.core.internal
  The version command.
QCommandVersion(QApplicationMetadata) - Constructor for class com.io7m.quarrel.core.internal.QCommandVersion
  The version command.
QCommandXS - Class in com.io7m.quarrel.ext.xstructural
  A command that produces an xstructural documentation template.
QCommandXS(String, boolean) - Constructor for class com.io7m.quarrel.ext.xstructural.QCommandXS
  A command that produces an xstructural documentation template.
QConstant(String) - Constructor for record class com.io7m.quarrel.core.QStringType.QConstant
  A string constant that can be directly displayed.
QEmptyResources - Class in com.io7m.quarrel.core.internal
  An empty resource bundle.
QEmptyResources() - Constructor for class com.io7m.quarrel.core.internal.QEmptyResources
  An empty resource bundle.
QErrorFormatting - Class in com.io7m.quarrel.core
  Standard functions to format errors.
QException - Exception Class in com.io7m.quarrel.core
  The type of exceptions raised by the package.
QException(String, String, Map, Optional, List) - Constructor for exception class com.io7m.quarrel.core.QException
  Construct an exception.
QException(String, Throwable, String, Map, Optional, List) - Constructor for exception class com.io7m.quarrel.core.QException
  Construct an exception.
QLocalization - Class in com.io7m.quarrel.core
  Convenient localization methods.
QLocalizationType - Interface in com.io7m.quarrel.core
  A simple interface to localize `QStringType` values.
QLocalize(String) - Constructor for record class com.io7m.quarrel.core.QStringType.QLocalize
  A string constant that must be localized from a resource.
QNames - Class in com.io7m.quarrel.core
  Valid names.
QParameterNamed01<T> - Record Class in com.io7m.quarrel.core
  A named parameter with [0, 1] cardinality; at most one value must be present.
QParameterNamed01(String, List, QStringType, Optional, Class) - Constructor for record class com.io7m.quarrel.core.QParameterNamed01
  A named parameter with [0, 1] cardinality; at most one value must be present.
QParameterNamed0N<T> - Record Class in com.io7m.quarrel.core
  A named parameter with [0, N] cardinality; any number of values may be present.
QParameterNamed0N(String, List, QStringType, List, Class) - Constructor for record class com.io7m.quarrel.core.QParameterNamed0N
  A named parameter with [0, N] cardinality; any number of values may be present.
QParameterNamed1<T> - Record Class in com.io7m.quarrel.core
  A named parameter with [1, 1] cardinality; exactly one value must be present.
QParameterNamed1(String, List, QStringType, Optional, Class) - Constructor for record class com.io7m.quarrel.core.QParameterNamed1
  A named parameter with [1, 1] cardinality; exactly one value must be present.
QParameterNamed1N<T> - Record Class in com.io7m.quarrel.core
  A named parameter with [1, N] cardinality; at least one value must be present.
QParameterNamed1N(String, List, QStringType, Optional, Class) - Constructor for record class com.io7m.quarrel.core.QParameterNamed1N
  A named parameter with [1, N] cardinality; at least one value must be present.
QParameterNamedType<T> - Interface in com.io7m.quarrel.core
  The type of named parameters.
QParameterPositional<T> - Record Class in com.io7m.quarrel.core
  A positional parameter.
QParameterPositional(String, QStringType, Class) - Constructor for record class com.io7m.quarrel.core.QParameterPositional
  A positional parameter.
QParametersPositionalAny - Record Class in com.io7m.quarrel.core
  Any positional arguments are allowed.
QParametersPositionalAny() - Constructor for record class com.io7m.quarrel.core.QParametersPositionalAny
  Creates an instance of a `QParametersPositionalAny` record class.
QParametersPositionalNone - Record Class in com.io7m.quarrel.core
  No positional arguments are allowed.
QParametersPositionalNone() - Constructor for record class com.io7m.quarrel.core.QParametersPositionalNone
  Creates an instance of a `QParametersPositionalNone` record class.
QParametersPositionalType - Interface in com.io7m.quarrel.core
  A specification for positional parameters.
QParametersPositionalTyped - Record Class in com.io7m.quarrel.core
  A list of typed positional parameters.
QParametersPositionalTyped(List) - Constructor for record class com.io7m.quarrel.core.QParametersPositionalTyped
  A list of typed positional parameters.
QParameterType<T> - Interface in com.io7m.quarrel.core
  The base type of parameters.
QResolutionErrorDoesNotExist(List, String) - Constructor for record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionErrorDoesNotExist
  The targeted object does not exist.
QResolutionOKCommand(QCommandType, List, List) - Constructor for record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionOKCommand
  The targeted object exists and is a command.
QResolutionOKGroup(QCommandGroupType, List) - Constructor for record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionOKGroup
  The targeted object exists and is a group.
QStrings - Class in com.io7m.quarrel.core.internal
  The string resources.
QStrings(Locale) - Constructor for class com.io7m.quarrel.core.internal.QStrings
  The string resources.
QStringType - Interface in com.io7m.quarrel.core
  A reference to a string.
QStringType.QConstant - Record Class in com.io7m.quarrel.core
  A string constant that can be directly displayed.
QStringType.QLocalize - Record Class in com.io7m.quarrel.core
  A string constant that must be localized from a resource.
QValueConverterDirectory - Class in com.io7m.quarrel.core
  The default value converter directory.
QValueConverterDirectoryType - Interface in com.io7m.quarrel.core
  A directory of value converters.
QValueConverterType<T> - Interface in com.io7m.quarrel.core
  The type of value converters.
QVCAbstract<T> - Class in com.io7m.quarrel.core.converters
  An abstract value converter.
QVCAbstract() - Constructor for class com.io7m.quarrel.core.converters.QVCAbstract
QVCBigDecimal - Class in com.io7m.quarrel.core.converters
  A value converter.
QVCBigInteger - Class in com.io7m.quarrel.core.converters
  A value converter.
QVCBoolean - Class in com.io7m.quarrel.core.converters
  A value converter.
QVCDouble - Class in com.io7m.quarrel.core.converters
  A value converter.
QVCDuration - Class in com.io7m.quarrel.core.converters
  A value converter.
QVCEnum<T> - Class in com.io7m.quarrel.core.converters
  An enum converter.
QVCEnum(Class) - Constructor for class com.io7m.quarrel.core.converters.QVCEnum
  An enum converter.
QVCFloat - Class in com.io7m.quarrel.core.converters
  A value converter.
QVCInetAddress - Class in com.io7m.quarrel.core.converters
  A value converter.
QVCInteger - Class in com.io7m.quarrel.core.converters
  A value converter.
QVCLong - Class in com.io7m.quarrel.core.converters
  A value converter.
QVCOffsetDateTime - Class in com.io7m.quarrel.core.converters
  A value converter.
QVCPath - Class in com.io7m.quarrel.core.converters
  A value converter.
QVCPattern - Class in com.io7m.quarrel.core.converters
  A value converter.
QVCString - Class in com.io7m.quarrel.core.converters
  A value converter.
QVCURI - Class in com.io7m.quarrel.core.converters
  A value converter.
QVCUUID - Class in com.io7m.quarrel.core.converters
  A value converter.

## R

remaining() - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionOKCommand
  Returns the value of the `remaining` record component.
remediatingAction() - Method in exception class com.io7m.quarrel.core.QException
resolve(Map, List) - Static method in class com.io7m.quarrel.core.QCommandTreeResolver
  Resolve an object.
ROOT - Enum constant in enum class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionRoot
  The targeted object is the root.
run() - Method in class com.io7m.quarrel.example.Main
run(Logger, List) - Method in interface com.io7m.quarrel.core.QApplicationType
  A convenience method that runs this application for the given arguments.

## S

setApplicationResources(ResourceBundle) - Method in interface com.io7m.quarrel.core.QApplicationBuilderType
  Set the application resources that will be used.
setInternalResources(ResourceBundle) - Method in interface com.io7m.quarrel.core.QApplicationBuilderType
  Set the internal resources that will be used.
setOutput(PrintWriter) - Method in interface com.io7m.quarrel.core.QApplicationBuilderType
  Set the output that will be used when executing commands.
setValueConverters(QValueConverterDirectoryType) - Method in interface com.io7m.quarrel.core.QApplicationBuilderType
  Set the value converters that will be used.
shortDescription() - Method in record class com.io7m.quarrel.core.QCommandMetadata
  Returns the value of the `shortDescription` record component.
site() - Method in record class com.io7m.quarrel.core.QApplicationMetadata
  Returns the value of the `site` record component.
SUCCESS - Enum constant in enum class com.io7m.quarrel.core.QCommandStatus
  The command succeeded.
syntax() - Method in class com.io7m.quarrel.core.converters.QVCBigDecimal
syntax() - Method in class com.io7m.quarrel.core.converters.QVCBigInteger
syntax() - Method in class com.io7m.quarrel.core.converters.QVCBoolean
syntax() - Method in class com.io7m.quarrel.core.converters.QVCDouble
syntax() - Method in class com.io7m.quarrel.core.converters.QVCDuration
syntax() - Method in class com.io7m.quarrel.core.converters.QVCEnum
syntax() - Method in class com.io7m.quarrel.core.converters.QVCFloat
syntax() - Method in class com.io7m.quarrel.core.converters.QVCInetAddress
syntax() - Method in class com.io7m.quarrel.core.converters.QVCInteger
syntax() - Method in class com.io7m.quarrel.core.converters.QVCLong
syntax() - Method in class com.io7m.quarrel.core.converters.QVCOffsetDateTime
syntax() - Method in class com.io7m.quarrel.core.converters.QVCPath
syntax() - Method in class com.io7m.quarrel.core.converters.QVCPattern
syntax() - Method in class com.io7m.quarrel.core.converters.QVCString
syntax() - Method in class com.io7m.quarrel.core.converters.QVCURI
syntax() - Method in class com.io7m.quarrel.core.converters.QVCUUID
syntax() - Method in interface com.io7m.quarrel.core.QValueConverterType

## T

target() - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionOKGroup
  Returns the value of the `target` record component.
text() - Method in record class com.io7m.quarrel.core.QStringType.QConstant
  Returns the value of the `text` record component.
title() - Method in record class com.io7m.quarrel.core.QApplicationMetadata
  Returns the value of the `title` record component.
toString() - Method in record class com.io7m.quarrel.core.QApplicationMetadata
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QCommandMetadata
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QCommandParserConfiguration
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionErrorDoesNotExist
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionOKCommand
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionOKGroup
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QParameterNamed01
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QParameterNamed0N
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QParameterNamed1
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QParameterNamed1N
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QParameterPositional
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QParametersPositionalAny
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QParametersPositionalNone
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QParametersPositionalTyped
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QStringType.QConstant
  Returns a string representation of this record class.
toString() - Method in record class com.io7m.quarrel.core.QStringType.QLocalize
  Returns a string representation of this record class.
toString() - Method in class com.io7m.quarrel.example.Main
type() - Method in record class com.io7m.quarrel.core.QParameterNamed01
  Returns the value of the `type` record component.
type() - Method in record class com.io7m.quarrel.core.QParameterNamed0N
  Returns the value of the `type` record component.
type() - Method in record class com.io7m.quarrel.core.QParameterNamed1
  Returns the value of the `type` record component.
type() - Method in record class com.io7m.quarrel.core.QParameterNamed1N
  Returns the value of the `type` record component.
type() - Method in record class com.io7m.quarrel.core.QParameterPositional
  Returns the value of the `type` record component.
type() - Method in interface com.io7m.quarrel.core.QParameterType

## V

valueConverters() - Method in class com.io7m.quarrel.core.internal.QCommandContext
valueConverters() - Method in class com.io7m.quarrel.core.QApplication
valueConverters() - Method in interface com.io7m.quarrel.core.QApplicationType
valueConverters() - Method in interface com.io7m.quarrel.core.QCommandContextType
  The value converters used to produce this context.
valueOf(String) - Static method in enum class com.io7m.quarrel.core.QCommandStatus
  Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionRoot
  Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.io7m.quarrel.core.QCommandStatus
  Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.io7m.quarrel.core.QCommandTreeResolver.QResolutionRoot
  Returns an array containing the constants of this enum class, in the order they are declared.
version() - Method in record class com.io7m.quarrel.core.QApplicationMetadata
  Returns the value of the `version` record component.

## W

with(QValueConverterType) - Method in interface com.io7m.quarrel.core.QValueConverterDirectoryType
  Extend this value converter directory with the given converter, returning a new directory.
with(Class, QValueConverterType) - Method in class com.io7m.quarrel.core.QValueConverterDirectory
with(Class, QValueConverterType) - Method in interface com.io7m.quarrel.core.QValueConverterDirectoryType
  Extend this value converter directory with the given converter, returning a new directory.

A B C D E F G H I L M N O P Q R S T V W
All Classes and Interfaces|All Packages|Serialized Form