Package com.github.tonivade.purefun.free

Record Class Free.Suspend<F extends Kind<F,?>,A>

java.lang.Object
java.lang.Record
com.github.tonivade.purefun.free.Free.Suspend<F,A>
All Implemented Interfaces:
Bindable<Free<F,?>,A>, Mappable<Free<F,?>,A>, Free<F,A>, FreeOf<F,A>, Kind<Free<F,?>,A>
Enclosing interface:
Free<F extends Kind<F,?>,A>
public static record Free.Suspend<F extends Kind<F,?>,A>(Kind<F extends Kind<F,?>,? extends A> value) extends Record implements Free<F,A>

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.github.tonivade.purefun.free.Free

    Free.FlatMapped<F extends Kind<F,?>,A,B>, Free.Pure<F extends Kind<F,?>,A>, Free.Suspend<F extends Kind<F,?>,A>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final Kind<F,? extends A>
    value
    The field for the value record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Suspend(Kind<F,? extends A> value)
    Creates an instance of a Suspend record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    <B> Free<F,B>
    flatMap(Function1<? super A,? extends Kind<Free<F,?>,? extends B>> map)
     
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.
    Kind<F,? extends A>
    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.free.Free

    andThen, foldMap, map

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

    fix, kind

  • Field Details

    • value

      private final Kind<F extends Kind<F,?>,? extends A> value
      The field for the value record component.

  • Constructor Details

    • Suspend

      public Suspend(Kind<F,? extends A> value)
      Creates an instance of a Suspend record class.
      Parameters:
      value - the value for the value record component

  • Method Details

    • flatMap

      public <B> Free<F,B> flatMap(Function1<? super A,? extends Kind<Free<F,?>,? extends B>> map)
      Specified by:
      flatMap in interface Bindable<F extends Kind<F,?>,A>
      Specified by:
      flatMap in interface Free<F extends Kind<F,?>,A>

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

    • value

      public Kind<F,? extends A> value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component