Package org.projectnessie.api.params

Class DiffParamsBuilder

java.lang.Object

org.projectnessie.api.params.DiffParamsBuilder

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@NotThreadSafe
public final class DiffParamsBuilder
extends Object

DiffParamsBuilder collects parameters and invokes the static factory method: new org.projectnessie.api.params.DiffParams(..). Call the build() method to get a result of type org.projectnessie.api.params.DiffParams.

DiffParamsBuilder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Constructor Summary

Constructors

Constructor	Description
DiffParamsBuilder()	Creates a DiffParamsBuilder factory builder.

Method Summary

Modifier and Type	Method	Description
DiffParams	build()	Invokes new org.projectnessie.api.params.DiffParams(..) using the collected parameters and returns the result of the invocation
DiffParamsBuilder	fromHashOnRef(String fromHashOnRef)	Initializes the value for the fromHashOnRef attribute.
DiffParamsBuilder	fromRef(String fromRef)	Initializes the value for the fromRef attribute.
DiffParamsBuilder	toHashOnRef(String toHashOnRef)	Initializes the value for the toHashOnRef attribute.
DiffParamsBuilder	toRef(String toRef)	Initializes the value for the toRef attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiffParamsBuilder

public DiffParamsBuilder()

Creates a DiffParamsBuilder factory builder.

 new DiffParamsBuilder()
    .fromRef(String) // required fromRef
    .fromHashOnRef(String | null) // nullable fromHashOnRef
    .toRef(String) // required toRef
    .toHashOnRef(String | null) // nullable toHashOnRef
    .build();
 

Method Detail

fromRef

@CanIgnoreReturnValue
public final DiffParamsBuilder fromRef(String fromRef)

Initializes the value for the fromRef attribute.

Parameters:

fromRef - The value for fromRef

Returns:

this builder for use in a chained invocation

fromHashOnRef

@CanIgnoreReturnValue
public final DiffParamsBuilder fromHashOnRef(@Nullable
                                             String fromHashOnRef)

Initializes the value for the fromHashOnRef attribute.

Parameters:

fromHashOnRef - The value for fromHashOnRef (can be null)

Returns:

this builder for use in a chained invocation

toRef

@CanIgnoreReturnValue
public final DiffParamsBuilder toRef(String toRef)

Initializes the value for the toRef attribute.

Parameters:

toRef - The value for toRef

Returns:

this builder for use in a chained invocation

toHashOnRef

@CanIgnoreReturnValue
public final DiffParamsBuilder toHashOnRef(@Nullable
                                           String toHashOnRef)

Initializes the value for the toHashOnRef attribute.

Parameters:

toHashOnRef - The value for toHashOnRef (can be null)

Returns:

this builder for use in a chained invocation

build

public DiffParams build()

Invokes new org.projectnessie.api.params.DiffParams(..) using the collected parameters and returns the result of the invocation

Returns:

A result of type org.projectnessie.api.params.DiffParams

Throws:

IllegalStateException - if any required attributes are missing