Module dev.nipafx.args

Package dev.nipafx.args

Interface ArgsMessage

All Known Subinterfaces:

ArgsMessage.ArgsErrorMessage, ArgsMessage.ArgsWarningMessage

All Known Implementing Classes:

ArgsMessage.FailedConstruction, ArgsMessage.IllegalModeValue, ArgsMessage.IllegalValue, ArgsMessage.MissingAction, ArgsMessage.MissingArgument, ArgsMessage.MissingValue, ArgsMessage.UnexpectedValue, ArgsMessage.UnknownAction, ArgsMessage.UnknownArgument

public sealed interface ArgsMessage
permits ArgsMessage.ArgsWarningMessage, ArgsMessage.ArgsErrorMessage

A warning or error resulting from faulty command line arguments.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ArgsMessage.ArgsErrorMessage	An error resulting from faulty command line arguments.
static interface	ArgsMessage.ArgsWarningMessage	A warning resulting from faulty command line arguments.
static final record	ArgsMessage.FailedConstruction	Indicates that an args record constructor threw an exception.
static final record	ArgsMessage.IllegalModeValue	Indicates that the value provided for the mode was unknown.
static final record	ArgsMessage.IllegalValue	Indicates that the value provided for the argument could not be parsed.
static final record	ArgsMessage.MissingAction	Indicates that the argument array was empty and no action was selected
static final record	ArgsMessage.MissingArgument	Indicates that a required (i.e.
static final record	ArgsMessage.MissingValue	Indicates that a required (i.e.
static final record	ArgsMessage.UnexpectedValue	Indicates that, at that position in the argument array, an argument was expected but instead a value was encountered.
static final record	ArgsMessage.UnknownAction	Indicates that the first argument was not a known value for the action.
static final record	ArgsMessage.UnknownArgument	Indicates that an argument couldn't be mapped to a record component.

Method Summary

Modifier and Type	Method	Description
default Optional<Throwable>	cause()	If the warning/error was caused by an exception, it is returned.
String	toMessage()	Returns a textual description of the warning/error that can be shown to the user.

Method Details

toMessage

String toMessage()

Returns a textual description of the warning/error that can be shown to the user.

Returns:

a textual description of the warning/error

cause

default Optional<Throwable> cause()

If the warning/error was caused by an exception, it is returned.

Returns:

the cause of the warning/error