Module dev.nipafx.args

Package dev.nipafx.args

Record Class ArgsMessage.FailedConstruction

java.lang.Object

java.lang.Record

dev.nipafx.args.ArgsMessage.FailedConstruction

Record Components:

exception - the exception thrown by the args record constructor

All Implemented Interfaces:

ArgsMessage, ArgsMessage.ArgsErrorMessage

Enclosing interface:

ArgsMessage

public static record ArgsMessage.FailedConstruction(Throwable exception)
extends Record
implements ArgsMessage.ArgsErrorMessage

Indicates that an args record constructor threw an exception.

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
FailedConstruction(Throwable exception)	Creates a message indicating that an args record constructor threw an exception.

Method Summary

Modifier and Type	Method	Description
Optional<Throwable>	cause()	If the warning/error was caused by an exception, it is returned.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Throwable	exception()	Returns the value of the exception record component.
final int	hashCode()	Returns a hash code value for this object.
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

Constructor Details

FailedConstruction

public FailedConstruction(Throwable exception)

Creates a message indicating that an args record constructor threw an exception.

Parameters:

exception - the exception thrown by the args record constructor

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

cause

public Optional<Throwable> cause()

Description copied from interface: ArgsMessage

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

Specified by:

cause in interface ArgsMessage

Returns:

the cause 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.

exception

public Throwable exception()

Returns the value of the exception record component.

Returns:

the value of the exception record component