de.flapdoodle.formula.calculate.functions

Class ImmutableFN3WithLabel<A,B,C,R>

java.lang.Object

de.flapdoodle.formula.calculate.functions.FN3.FN3WithLabel<A,B,C,R>

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

All Implemented Interfaces:

FN3<A,B,C,R>, HasHumanReadableLabel

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableFN3WithLabel<A,B,C,R>
extends FN3.FN3WithLabel<A,B,C,R>

Immutable implementation of FN3.FN3WithLabel.

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

Nested Class Summary

Nested Classes

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

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

FN3.FN3checkNull<A,B,C,R>, FN3.FN3WithLabel<A,B,C,R>, FN3.FN3wrapF3<A,B,C,R>

Method Summary

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

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

checkNull, mapOnlyIfNotNull, withLabel

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

asHumanReadable

Method Detail

delegate

protected FN3<A,B,C,R> delegate()

Specified by:

delegate in class FN3.FN3WithLabel<A,B,C,R>

Returns:

The value of the delegate attribute

label

protected String label()

Specified by:

label in class FN3.FN3WithLabel<A,B,C,R>

Returns:

The value of the label attribute

withDelegate

public final ImmutableFN3WithLabel<A,B,C,R> withDelegate(FN3<A,B,C,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 ImmutableFN3WithLabel<A,B,C,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 ImmutableFN3WithLabel 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 FN3WithLabel with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <A,B,C,R> ImmutableFN3WithLabel<A,B,C,R> of(FN3<A,B,C,R> delegate,
                                                          String label)

Construct a new immutable FN3WithLabel instance.

Type Parameters:

A - generic parameter A

B - generic parameter B

C - generic parameter C

R - generic parameter R

Parameters:

delegate - The value for the delegate attribute

label - The value for the label attribute

Returns:

An immutable FN3WithLabel instance

copyOf

public static <A,B,C,R> ImmutableFN3WithLabel<A,B,C,R> copyOf(FN3.FN3WithLabel<A,B,C,R> instance)

Creates an immutable copy of a FN3.FN3WithLabel 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

C - generic parameter C

R - generic parameter R

Parameters:

instance - The instance to copy

Returns:

A copied immutable FN3WithLabel instance

builder

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

Creates a builder for ImmutableFN3WithLabel.

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

Type Parameters:

A - generic parameter A

B - generic parameter B

C - generic parameter C

R - generic parameter R

Returns:

A new ImmutableFN3WithLabel builder