Package com.github.tonivade.purefun.type

Record Class Id<T>

java.lang.Object

java.lang.Record

com.github.tonivade.purefun.type.Id<T>

Type Parameters:

T - the wrapped value

All Implemented Interfaces:

Applicable<Id<?>,T>, Bindable<Id<?>,T>, Mappable<Id<?>,T>, Kind<Id<?>,T>, IdOf<T>, Serializable

public record Id<T>(T value)
extends Record
implements IdOf<T>, Bindable<Id<?>,T>, Applicable<Id<?>,T>, Serializable

This is the identity monad. It only wraps the value and nothing more.

You can go from T to Id<T> and from Id<T> to T without loosing information.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.tonivade.purefun.core.Applicable

Applicable.Map2<F extends Applicable<F,?>,A,B>, Applicable.Map3<F extends Applicable<F,?>,A,B,C>, Applicable.Map4<F extends Applicable<F,?>,A,B,C,D>, Applicable.Map5<F extends Applicable<F,?>,A,B,C,D,E>

Field Summary

Fields

Modifier and Type	Field	Description
private final T	value	The field for the value record component.

Constructor Summary

Constructors

Constructor	Description
Id(T value)	Creates an instance of a Id record class.

Method Summary

Modifier and Type	Method	Description
<R> Id<R>	ap(Kind<Id<?>,? extends Function1<? super T,? extends R>> apply)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
<R> Id<R>	flatMap(Function1<? super T,? extends Kind<Id<?>,? extends R>> map)
final int	hashCode()	Returns a hash code value for this object.
<R> Id<R>	map(Function1<? super T,? extends R> map)
static <T> Id<T>	of(T value)
String	toString()	Returns a string representation of this record class.
T	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.tonivade.purefun.core.Applicable

zip, zipLeft, zipRight, zipWith

Methods inherited from interface com.github.tonivade.purefun.core.Bindable

andThen

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

fix, kind

Field Details

value

private final T value

The field for the value record component.

Constructor Details

Id

public Id(T value)

Creates an instance of a Id record class.

Parameters:

value - the value for the value record component

Method Details

map

public <R> Id<R> map(Function1<? super T,? extends R> map)

Specified by:

map in interface Applicable<Id<?>,T>

Specified by:

map in interface Bindable<Id<?>,T>

Specified by:

map in interface Mappable<Id<?>,T>

ap

public <R> Id<R> ap(Kind<Id<?>,? extends Function1<? super T,? extends R>> apply)

Specified by:

ap in interface Applicable<Id<?>,T>

flatMap

public <R> Id<R> flatMap(Function1<? super T,? extends Kind<Id<?>,? extends R>> map)

Specified by:

flatMap in interface Bindable<Id<?>,T>

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

of

public static <T> Id<T> of(T value)

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.

value

public T value()

Returns the value of the value record component.

Returns:

the value of the value record component