Module dev.nipafx.args

Package dev.nipafx.args

Record Class ArgsMessage.IllegalModeValue

java.lang.Object

java.lang.Record

dev.nipafx.args.ArgsMessage.IllegalModeValue

Record Components:

modeName - the name of the mode (which doesn't include "--")

allowedValues - the allowed values

actualValue - the actual value provided for the mode

All Implemented Interfaces:

ArgsMessage, ArgsMessage.ArgsErrorMessage

Enclosing interface:

ArgsMessage

public static record ArgsMessage.IllegalModeValue(String modeName, Set<String> allowedValues, String actualValue)
extends Record
implements ArgsMessage.ArgsErrorMessage

Indicates that the value provided for the mode was unknown.

Nested Class Summary

Nested classes/interfaces inherited from interface dev.nipafx.args.ArgsMessage

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

Constructor Summary

Constructors

Constructor	Description
IllegalModeValue(String modeName, Set<String> allowedValues, String actualValue)	Creates a message indicating that the value provided for the mode was unknown.

Method Summary

Modifier and Type	Method	Description
String	actualValue()	Returns the value of the actualValue record component.
Set<String>	allowedValues()	Returns the value of the allowedValues record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	modeName()	Returns the value of the modeName record component.
String	toMessage()	Returns a textual description of the warning/error that can be shown to the user.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.nipafx.args.ArgsMessage

cause

Constructor Details

IllegalModeValue

public IllegalModeValue(String modeName,
 Set<String> allowedValues,
 String actualValue)

Creates a message indicating that the value provided for the mode was unknown.

Parameters:

modeName - the name of the mode (which doesn't include "--")

allowedValues - the allowed values

actualValue - the actual value provided for the mode

Method Details

toMessage

public String toMessage()

Description copied from interface: ArgsMessage

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

Specified by:

toMessage in interface ArgsMessage

Returns:

a textual description of the warning/error

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

modeName

public String modeName()

Returns the value of the modeName record component.

Returns:

the value of the modeName record component

allowedValues

public Set<String> allowedValues()

Returns the value of the allowedValues record component.

Returns:

the value of the allowedValues record component

actualValue

public String actualValue()

Returns the value of the actualValue record component.

Returns:

the value of the actualValue record component