Index (RecordArgs 0.8.1 API)

A C D E F H I M P S T U V
All Classes and Interfaces|All Packages|Serialized Form

A

actualValue() - Method in record class dev.nipafx.args.ArgsMessage.IllegalModeValue: Returns the value of the actualValue record component.
actualValue() - Method in record class dev.nipafx.args.ArgsMessage.UnknownAction: Returns the value of the actualValue record component.
allowedValues() - Method in record class dev.nipafx.args.ArgsMessage.IllegalModeValue: Returns the value of the allowedValues record component.
allowedValues() - Method in record class dev.nipafx.args.ArgsMessage.MissingAction: Returns the value of the allowedValues record component.
allowedValues() - Method in record class dev.nipafx.args.ArgsMessage.UnknownAction: Returns the value of the allowedValues record component.
args() - Method in exception class dev.nipafx.args.ArgsParseException: Returns the argument array passed to Args.
Args - Class in dev.nipafx.args: Parses command-line arguments to args records - call parse or one of its overloads (depending on how many args types are involved).
ArgsDefinitionErrorCode - Enum Class in dev.nipafx.args: Encodes various definition errors that the developer(s) using RecordArgs must fix.
ArgsDefinitionException - Exception Class in dev.nipafx.args: Thrown when the types provided to Args::parse are ill-defined.
ArgsMessage - Interface in dev.nipafx.args: A warning or error resulting from faulty command line arguments.
ArgsMessage.ArgsErrorMessage - Interface in dev.nipafx.args: An error resulting from faulty command line arguments.
ArgsMessage.ArgsWarningMessage - Interface in dev.nipafx.args: A warning resulting from faulty command line arguments.
ArgsMessage.FailedConstruction - Record Class in dev.nipafx.args: Indicates that an args record constructor threw an exception.
ArgsMessage.IllegalModeValue - Record Class in dev.nipafx.args: Indicates that the value provided for the mode was unknown.
ArgsMessage.IllegalValue - Record Class in dev.nipafx.args: Indicates that the value provided for the argument could not be parsed.
ArgsMessage.MissingAction - Record Class in dev.nipafx.args: Indicates that the argument array was empty and no action was selected
ArgsMessage.MissingArgument - Record Class in dev.nipafx.args: Indicates that a required (i.e.
ArgsMessage.MissingValue - Record Class in dev.nipafx.args: Indicates that a required (i.e.
ArgsMessage.UnexpectedValue - Record Class in dev.nipafx.args: Indicates that, at that position in the argument array, an argument was expected but instead a value was encountered.
ArgsMessage.UnknownAction - Record Class in dev.nipafx.args: Indicates that the first argument was not a known value for the action.
ArgsMessage.UnknownArgument - Record Class in dev.nipafx.args: Indicates that an argument couldn't be mapped to a record component.
ArgsParseException - Exception Class in dev.nipafx.args: Thrown when parsing command line arguments fails.
argumentName() - Method in record class dev.nipafx.args.ArgsMessage.IllegalValue: Returns the value of the argumentName record component.
argumentName() - Method in record class dev.nipafx.args.ArgsMessage.MissingArgument: Returns the value of the argumentName record component.
argumentName() - Method in record class dev.nipafx.args.ArgsMessage.MissingValue: Returns the value of the argumentName record component.
argumentName() - Method in record class dev.nipafx.args.ArgsMessage.UnknownArgument: Returns the value of the argumentName record component.
argumentType() - Method in record class dev.nipafx.args.ArgsMessage.IllegalValue: Returns the value of the argumentType record component.

C

cause() - Method in interface dev.nipafx.args.ArgsMessage: If the warning/error was caused by an exception, it is returned.
cause() - Method in record class dev.nipafx.args.ArgsMessage.FailedConstruction

D

dev.nipafx.args - module dev.nipafx.args: A simple command-line argument parser for Java applications that relies on records and sealed interfaces.
dev.nipafx.args - package dev.nipafx.args: Main package of Record Args - see module declaration and Args for documentation.
DUPLICATE_ARGUMENT_DEFINITION - Enum constant in enum class dev.nipafx.args.ArgsDefinitionErrorCode: Args::parse was called with at least two records that have components of the same name.

E

equals(Object) - Method in record class dev.nipafx.args.ArgsMessage.FailedConstruction: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.nipafx.args.ArgsMessage.IllegalModeValue: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.nipafx.args.ArgsMessage.IllegalValue: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.nipafx.args.ArgsMessage.MissingAction: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.nipafx.args.ArgsMessage.MissingArgument: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.nipafx.args.ArgsMessage.MissingValue: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.nipafx.args.ArgsMessage.UnexpectedValue: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.nipafx.args.ArgsMessage.UnknownAction: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.nipafx.args.ArgsMessage.UnknownArgument: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.nipafx.args.Parsed2: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.nipafx.args.Parsed3: Indicates whether some other object is "equal to" this one.
errorCode() - Method in exception class dev.nipafx.args.ArgsDefinitionException: Returns an error code that describes the cause of the exception.
errors() - Method in exception class dev.nipafx.args.ArgsParseException: Returns ArgsMessages that describe the errors.
exception() - Method in record class dev.nipafx.args.ArgsMessage.FailedConstruction: Returns the value of the exception record component.

F

FailedConstruction(Throwable) - Constructor for record class dev.nipafx.args.ArgsMessage.FailedConstruction: Creates a message indicating that an args record constructor threw an exception.
FAULTY_STATIC_INITIALIZER - Enum constant in enum class dev.nipafx.args.ArgsDefinitionErrorCode: An args record's static initializer threw an error.
first() - Method in record class dev.nipafx.args.Parsed2: Returns the value of the first record component.
first() - Method in record class dev.nipafx.args.Parsed3: Returns the value of the first record component.

H

hashCode() - Method in record class dev.nipafx.args.ArgsMessage.FailedConstruction: Returns a hash code value for this object.
hashCode() - Method in record class dev.nipafx.args.ArgsMessage.IllegalModeValue: Returns a hash code value for this object.
hashCode() - Method in record class dev.nipafx.args.ArgsMessage.IllegalValue: Returns a hash code value for this object.
hashCode() - Method in record class dev.nipafx.args.ArgsMessage.MissingAction: Returns a hash code value for this object.
hashCode() - Method in record class dev.nipafx.args.ArgsMessage.MissingArgument: Returns a hash code value for this object.
hashCode() - Method in record class dev.nipafx.args.ArgsMessage.MissingValue: Returns a hash code value for this object.
hashCode() - Method in record class dev.nipafx.args.ArgsMessage.UnexpectedValue: Returns a hash code value for this object.
hashCode() - Method in record class dev.nipafx.args.ArgsMessage.UnknownAction: Returns a hash code value for this object.
hashCode() - Method in record class dev.nipafx.args.ArgsMessage.UnknownArgument: Returns a hash code value for this object.
hashCode() - Method in record class dev.nipafx.args.Parsed2: Returns a hash code value for this object.
hashCode() - Method in record class dev.nipafx.args.Parsed3: Returns a hash code value for this object.

I

ILL_DEFINED_ARGS_TYPE - Enum constant in enum class dev.nipafx.args.ArgsDefinitionErrorCode: An args types was neither a record nor a sealed interfaces with exclusively record implementations.
ILLEGAL_ACCESS - Enum constant in enum class dev.nipafx.args.ArgsDefinitionErrorCode: RecordArgs has no reflective access to all args types.
IllegalModeValue(String, Set<String>, String) - Constructor for record class dev.nipafx.args.ArgsMessage.IllegalModeValue: Creates a message indicating that the value provided for the mode was unknown.
IllegalValue(String, Class<?>, String, Throwable) - Constructor for record class dev.nipafx.args.ArgsMessage.IllegalValue: Creates a message indicating that the value provided for the argument could not be parsed.

M

MissingAction(Set<String>) - Constructor for record class dev.nipafx.args.ArgsMessage.MissingAction: Creates a message indicating that the argument array was empty and no action was selected
MissingArgument(String) - Constructor for record class dev.nipafx.args.ArgsMessage.MissingArgument: Creates a message indicating that a required (i.e.
MissingValue(String) - Constructor for record class dev.nipafx.args.ArgsMessage.MissingValue: Creates a message indicating that a required (i.e.
modeName() - Method in record class dev.nipafx.args.ArgsMessage.IllegalModeValue: Returns the value of the modeName record component.
MULTIPLE_ACTIONS - Enum constant in enum class dev.nipafx.args.ArgsDefinitionErrorCode: At most one sealed interface may be called Action or ActionArgs.

P

parse(String[], Class<ARGS_TYPE_1>, Class<ARGS_TYPE_2>) - Static method in class dev.nipafx.args.Args: Parses the specified string array to create instances of the specified types.
parse(String[], Class<ARGS_TYPE_1>, Class<ARGS_TYPE_2>, Class<ARGS_TYPE_3>) - Static method in class dev.nipafx.args.Args: Parses the specified string array to create instances of the specified types.
parse(String[], Class<ARGS_TYPE>) - Static method in class dev.nipafx.args.Args: Parses the specified string array to create an instance of the specified type.
Parsed2<ARGS_TYPE_1,ARGS_TYPE_2> - Record Class in dev.nipafx.args: Result of parsing arguments to two args records with Args.parse(String[], Class, Class).
Parsed2(ARGS_TYPE_1, ARGS_TYPE_2) - Constructor for record class dev.nipafx.args.Parsed2: Creates a new parsing result.
Parsed3<ARGS_TYPE_1,ARGS_TYPE_2,ARGS_TYPE_3> - Record Class in dev.nipafx.args: Result of parsing arguments to three args records with Args.parse(String[], Class, Class, Class).
Parsed3(ARGS_TYPE_1, ARGS_TYPE_2, ARGS_TYPE_3) - Constructor for record class dev.nipafx.args.Parsed3: Creates a new parsing result.
parseError() - Method in record class dev.nipafx.args.ArgsMessage.IllegalValue: Returns the value of the parseError record component.

S

second() - Method in record class dev.nipafx.args.Parsed2: Returns the value of the second record component.
second() - Method in record class dev.nipafx.args.Parsed3: Returns the value of the second record component.

T

third() - Method in record class dev.nipafx.args.Parsed3: Returns the value of the third record component.
toMessage() - Method in record class dev.nipafx.args.ArgsMessage.FailedConstruction
toMessage() - Method in record class dev.nipafx.args.ArgsMessage.IllegalModeValue
toMessage() - Method in record class dev.nipafx.args.ArgsMessage.IllegalValue
toMessage() - Method in record class dev.nipafx.args.ArgsMessage.MissingAction
toMessage() - Method in record class dev.nipafx.args.ArgsMessage.MissingArgument
toMessage() - Method in record class dev.nipafx.args.ArgsMessage.MissingValue
toMessage() - Method in interface dev.nipafx.args.ArgsMessage: Returns a textual description of the warning/error that can be shown to the user.
toMessage() - Method in record class dev.nipafx.args.ArgsMessage.UnexpectedValue
toMessage() - Method in record class dev.nipafx.args.ArgsMessage.UnknownAction
toMessage() - Method in record class dev.nipafx.args.ArgsMessage.UnknownArgument
toString() - Method in record class dev.nipafx.args.ArgsMessage.FailedConstruction: Returns a string representation of this record class.
toString() - Method in record class dev.nipafx.args.ArgsMessage.IllegalModeValue: Returns a string representation of this record class.
toString() - Method in record class dev.nipafx.args.ArgsMessage.IllegalValue: Returns a string representation of this record class.
toString() - Method in record class dev.nipafx.args.ArgsMessage.MissingAction: Returns a string representation of this record class.
toString() - Method in record class dev.nipafx.args.ArgsMessage.MissingArgument: Returns a string representation of this record class.
toString() - Method in record class dev.nipafx.args.ArgsMessage.MissingValue: Returns a string representation of this record class.
toString() - Method in record class dev.nipafx.args.ArgsMessage.UnexpectedValue: Returns a string representation of this record class.
toString() - Method in record class dev.nipafx.args.ArgsMessage.UnknownAction: Returns a string representation of this record class.
toString() - Method in record class dev.nipafx.args.ArgsMessage.UnknownArgument: Returns a string representation of this record class.
toString() - Method in record class dev.nipafx.args.Parsed2: Returns a string representation of this record class.
toString() - Method in record class dev.nipafx.args.Parsed3: Returns a string representation of this record class.
types() - Method in exception class dev.nipafx.args.ArgsParseException: Returns the args types that were supposed to be created.

U

UnexpectedValue(String) - Constructor for record class dev.nipafx.args.ArgsMessage.UnexpectedValue: Creates a message indicating that, at that position in the argument array, an argument was expected but instead a value was encountered.
UnknownAction(Set<String>, String) - Constructor for record class dev.nipafx.args.ArgsMessage.UnknownAction: Creates a message indicating that the first argument was not a known value for the action.
UnknownArgument(String) - Constructor for record class dev.nipafx.args.ArgsMessage.UnknownArgument: Creates a message indicating that an argument couldn't be mapped to a record component.
UNSUPPORTED_ARGUMENT_TYPE - Enum constant in enum class dev.nipafx.args.ArgsDefinitionErrorCode: An args record had an unsupported component type.

V

value() - Method in record class dev.nipafx.args.ArgsMessage.IllegalValue: Returns the value of the value record component.
value() - Method in record class dev.nipafx.args.ArgsMessage.UnexpectedValue: Returns the value of the value record component.
valueOf(String) - Static method in enum class dev.nipafx.args.ArgsDefinitionErrorCode: Returns the enum constant of this class with the specified name.
values() - Static method in enum class dev.nipafx.args.ArgsDefinitionErrorCode: Returns an array containing the constants of this enum class, in the order they are declared.

A C D E F H I M P S T U V
All Classes and Interfaces|All Packages|Serialized Form