fr.flowarg.flowupdater.utils.builderapi

Class BuilderArgument<T>

java.lang.Object

fr.flowarg.flowupdater.utils.builderapi.BuilderArgument<T>

Type Parameters:

T - Object Argument

public class BuilderArgument<T>
extends java.lang.Object

Builder API; Represent an argument for a Builder implementation.

Constructor Summary

Constructors

Constructor and Description
BuilderArgument(java.lang.String objectName) Construct a new basic BuilderArgument.
BuilderArgument(java.lang.String objectName, @NotNull java.util.function.Supplier<T> initialValue) Construct a new BuilderArgument.
BuilderArgument(java.lang.String objectName, @NotNull java.util.function.Supplier<T> initialValue, @NotNull java.util.function.Supplier<T> badObject) Construct a new BuilderArgument.
BuilderArgument(@NotNull java.util.function.Supplier<T> badObject, java.lang.String objectName) Construct a new BuilderArgument.

Method Summary

Modifier and Type	Method and Description
T	badObject() Get the bad object.
T	get() Check and get the wrapped object.
java.lang.String	getObjectName() Get the name of the current object's name.
BuilderArgument<T>	optional() Indicate that argument is optional.
BuilderArgument<T>	require(BuilderArgument<?>... required) Indicate that provided arguments are required if this argument is built.
BuilderArgument<T>	required() Indicate that argument is required.
void	set(T object) Define the new wrapped object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BuilderArgument

public BuilderArgument(java.lang.String objectName,
                       @NotNull
                       @NotNull java.util.function.Supplier<T> initialValue)

Construct a new BuilderArgument.

Parameters:

objectName - The name of the object.

initialValue - The initial value's wrapper.

BuilderArgument

public BuilderArgument(java.lang.String objectName)

Construct a new basic BuilderArgument.

Parameters:

objectName - The name of the object.

BuilderArgument

public BuilderArgument(java.lang.String objectName,
                       @NotNull
                       @NotNull java.util.function.Supplier<T> initialValue,
                       @NotNull
                       @NotNull java.util.function.Supplier<T> badObject)

Construct a new BuilderArgument.

Parameters:

objectName - The name of the object.

initialValue - The initial value's wrapper.

badObject - The initial bad value's wrapper.

BuilderArgument

public BuilderArgument(@NotNull
                       @NotNull java.util.function.Supplier<T> badObject,
                       java.lang.String objectName)

Construct a new BuilderArgument.

Parameters:

badObject - The initial bad value's wrapper.

objectName - The name of the object.

Method Detail

get

public T get()
      throws BuilderException

Check and get the wrapped object.

Returns:

the wrapper object.

Throws:

BuilderException - it the builder configuration is invalid.

set

public void set(T object)

Define the new wrapped object.

Parameters:

object - the new wrapper object to define.

require

public BuilderArgument<T> require(BuilderArgument<?>... required)

Indicate that provided arguments are required if this argument is built.

Parameters:

required - required arguments.

Returns:

this.

required

public BuilderArgument<T> required()

Indicate that argument is required.

Returns:

this.

optional

public BuilderArgument<T> optional()

Indicate that argument is optional.

Returns:

this.

getObjectName

public java.lang.String getObjectName()

Get the name of the current object's name.

Returns:

the object's name.

badObject

public T badObject()

Get the bad object.

Returns:

the bad object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object