de.flapdoodle.formula.calculate.functions

Class ImmutableFN2WithLabel<A,B,R>

java.lang.Object

de.flapdoodle.formula.calculate.functions.FN2.FN2WithLabel<A,B,R>

de.flapdoodle.formula.calculate.functions.ImmutableFN2WithLabel<A,B,R>

All Implemented Interfaces:

FN2<A,B,R>, HasHumanReadableLabel, BiFunction<A,B,R>

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableFN2WithLabel<A,B,R>
extends FN2.FN2WithLabel<A,B,R>

Immutable implementation of FN2.FN2WithLabel.

Use the builder to create immutable instances: ImmutableFN2WithLabel.builder(). Use the static factory method to create immutable instances: ImmutableFN2WithLabel.of().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableFN2WithLabel.Builder<A,B,R> Builds instances of type ImmutableFN2WithLabel.

Nested classes/interfaces inherited from interface de.flapdoodle.formula.calculate.functions.FN2

FN2.FN2checkNull<A,B,R>, FN2.FN2WithLabel<A,B,R>, FN2.FN2wrapF2<A,B,R>

Method Summary

Modifier and Type	Method and Description
static <A,B,R> ImmutableFN2WithLabel.Builder<A,B,R>	builder() Creates a builder for ImmutableFN2WithLabel.
static <A,B,R> ImmutableFN2WithLabel<A,B,R>	copyOf(FN2.FN2WithLabel<A,B,R> instance) Creates an immutable copy of a FN2.FN2WithLabel value.
protected FN2<A,B,R>	delegate()
boolean	equals(Object another) This instance is equal to all instances of ImmutableFN2WithLabel that have equal attribute values.
int	hashCode() Computes a hash code from attributes: delegate, label.
protected String	label()
static <A,B,R> ImmutableFN2WithLabel<A,B,R>	of(FN2<A,B,R> delegate, String label) Construct a new immutable FN2WithLabel instance.
String	toString() Prints the immutable value FN2WithLabel with attribute values.
ImmutableFN2WithLabel<A,B,R>	withDelegate(FN2<A,B,R> value) Copy the current immutable object by setting a value for the delegate attribute.
ImmutableFN2WithLabel<A,B,R>	withLabel(String value) Copy the current immutable object by setting a value for the label attribute.

Methods inherited from class de.flapdoodle.formula.calculate.functions.FN2.FN2WithLabel

apply, asHumanReadable

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.formula.calculate.functions.FN2

checkNull, mapOnlyIfNotNull, withLabel

Methods inherited from interface java.util.function.BiFunction

andThen

Methods inherited from interface de.flapdoodle.formula.types.HasHumanReadableLabel

asHumanReadable

Method Detail

delegate

protected FN2<A,B,R> delegate()

Specified by:

delegate in class FN2.FN2WithLabel<A,B,R>

Returns:

The value of the delegate attribute

label

protected String label()

Specified by:

label in class FN2.FN2WithLabel<A,B,R>

Returns:

The value of the label attribute

withDelegate

public final ImmutableFN2WithLabel<A,B,R> withDelegate(FN2<A,B,R> value)

Copy the current immutable object by setting a value for the delegate attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for delegate

Returns:

A modified copy of the this object

withLabel

public final ImmutableFN2WithLabel<A,B,R> withLabel(String value)

Copy the current immutable object by setting a value for the label attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for label

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableFN2WithLabel that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: delegate, label.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value FN2WithLabel with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <A,B,R> ImmutableFN2WithLabel<A,B,R> of(FN2<A,B,R> delegate,
                                                      String label)

Construct a new immutable FN2WithLabel instance.

Type Parameters:

A - generic parameter A

B - generic parameter B

R - generic parameter R

Parameters:

delegate - The value for the delegate attribute

label - The value for the label attribute

Returns:

An immutable FN2WithLabel instance

copyOf

public static <A,B,R> ImmutableFN2WithLabel<A,B,R> copyOf(FN2.FN2WithLabel<A,B,R> instance)

Creates an immutable copy of a FN2.FN2WithLabel value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Type Parameters:

A - generic parameter A

B - generic parameter B

R - generic parameter R

Parameters:

instance - The instance to copy

Returns:

A copied immutable FN2WithLabel instance

builder

public static <A,B,R> ImmutableFN2WithLabel.Builder<A,B,R> builder()

Creates a builder for ImmutableFN2WithLabel.

 ImmutableFN2WithLabel.<A, B, R>builder()
    .delegate(de.flapdoodle.formula.calculate.functions.FN2<A, B, R>) // required delegate
    .label(String) // required label
    .build();
 

Type Parameters:

A - generic parameter A

B - generic parameter B

R - generic parameter R

Returns:

A new ImmutableFN2WithLabel builder