ImmutableFN2checkNull (Flapdoodle Formula 1.6.0 API)

java.lang.Object
- de.flapdoodle.formula.calculate.functions.FN2.FN2checkNull<A,B,R>
- - de.flapdoodle.formula.calculate.functions.ImmutableFN2checkNull<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 ImmutableFN2checkNull<A,B,R>
extends FN2.FN2checkNull<A,B,R>
```
Immutable implementation of FN2.FN2checkNull.
Use the builder to create immutable instances: ImmutableFN2checkNull.builder(). Use the static factory method to create immutable instances: ImmutableFN2checkNull.of().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableFN2checkNull.Builder<A,B,R>
Builds instances of type ImmutableFN2checkNull.
- 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>

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableFN2checkNull.Builder<A,B,R>` Builds instances of type `ImmutableFN2checkNull`.

Method Summary

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

Methods inherited from class de.flapdoodle.formula.calculate.functions.FN2.FN2checkNull
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 F2<A,B,R> delegate()
```
    Specified by:
    
    delegate in class FN2.FN2checkNull<A,B,R>
    
    Returns:
    
    The value of the delegate attribute
  - a
```
protected String a()
```
    Specified by:
    
    a in class FN2.FN2checkNull<A,B,R>
    
    Returns:
    
    The value of the a attribute
  - b
```
protected String b()
```
    Specified by:
    
    b in class FN2.FN2checkNull<A,B,R>
    
    Returns:
    
    The value of the b attribute
  - withDelegate
```
public final ImmutableFN2checkNull<A,B,R> withDelegate(F2<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
  - withA
```
public final ImmutableFN2checkNull<A,B,R> withA(String value)
```
    Copy the current immutable object by setting a value for the a attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for a
    
    Returns:
    
    A modified copy of the this object
  - withB
```
public final ImmutableFN2checkNull<A,B,R> withB(String value)
```
    Copy the current immutable object by setting a value for the b attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for b
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableFN2checkNull 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, a, b.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value FN2checkNull with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - of
```
public static <A,B,R> ImmutableFN2checkNull<A,B,R> of(F2<A,B,R> delegate,
                                                      String a,
                                                      String b)
```
    Construct a new immutable FN2checkNull instance.
    
    Type Parameters:
    
    A - generic parameter A
    
    B - generic parameter B
    
    R - generic parameter R
    
    Parameters:
    
    delegate - The value for the delegate attribute
    
    a - The value for the a attribute
    
    b - The value for the b attribute
    
    Returns:
    
    An immutable FN2checkNull instance
  - copyOf
```
public static <A,B,R> ImmutableFN2checkNull<A,B,R> copyOf(FN2.FN2checkNull<A,B,R> instance)
```
    Creates an immutable copy of a FN2.FN2checkNull 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 FN2checkNull instance
  - builder
```
public static <A,B,R> ImmutableFN2checkNull.Builder<A,B,R> builder()
```
    Creates a builder for ImmutableFN2checkNull.
```
 ImmutableFN2checkNull.&lt;A, B, R&gt;builder()
    .delegate(de.flapdoodle.formula.calculate.functions.F2&lt;A, B, R&gt;) // required delegate
    .a(String) // required a
    .b(String) // required b
    .build();
 
```
    Type Parameters:
    
    A - generic parameter A
    
    B - generic parameter B
    
    R - generic parameter R
    
    Returns:
    
    A new ImmutableFN2checkNull builder

Class ImmutableFN2checkNull<A,B,R>

Nested Class Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

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

Method Detail

delegate

a

b

withDelegate

withA

withB

equals

hashCode

toString

of

copyOf

builder