Package com.github.tonivade.purefun.type

Record Class Validation.Invalid<E,T>

java.lang.Object

java.lang.Record

com.github.tonivade.purefun.type.Validation.Invalid<E,T>

All Implemented Interfaces:

Bindable<Validation<E,?>,T>, Mappable<Validation<E,?>,T>, Kind<Validation<E,?>,T>, Validation<E,T>, ValidationOf<E,T>, Serializable

Enclosing interface:

Validation<E,T>

public static record Validation.Invalid<E,T>(E error)
extends Record
implements Validation<E,T>, Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.tonivade.purefun.type.Validation

Validation.Invalid<E,T>, Validation.Result<E>, Validation.Valid<E,T>

Field Summary

Fields

Modifier and Type	Field	Description
private final E	error	The field for the error record component.

Constructor Summary

Constructors

Constructor	Description
Invalid(E error)	Creates an instance of a Invalid record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
E	error()	Returns the value of the error record component.
T	get()	Returns the valid value if available.
E	getError()	Returns the invalid value if available.
final int	hashCode()	Returns a hash code value for this object.
boolean	isInvalid()
boolean	isValid()
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 com.github.tonivade.purefun.core.Bindable

andThen

Methods inherited from interface com.github.tonivade.purefun.Kind

fix, kind

Methods inherited from interface com.github.tonivade.purefun.type.Validation

ap, bimap, filter, filterNot, filterOrElse, flatMap, fold, getOrElse, getOrElse, getOrElseNull, getOrElseThrow, getOrElseThrow, map, mapError, or, orElse, toEither

Field Details

error

private final E error

The field for the error record component.

Constructor Details

Invalid

public Invalid(E error)

Creates an instance of a Invalid record class.

Parameters:

error - the value for the error record component

Method Details

isValid

public boolean isValid()

Specified by:

isValid in interface Validation<E,T>

isInvalid

public boolean isInvalid()

Specified by:

isInvalid in interface Validation<E,T>

get

public T get()

Description copied from interface: Validation

Returns the valid value if available. If not, it throws NoSuchElementException

Specified by:

get in interface Validation<E,T>

Returns:

the valid value

getError

public E getError()

Description copied from interface: Validation

Returns the invalid value if available. If not, it throws NoSuchElementException

Specified by:

getError in interface Validation<E,T>

Returns:

the invalid value

toString

public 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.

error

public E error()

Returns the value of the error record component.

Returns:

the value of the error record component