org.nuiton.db.meta

Class ImmutableProcedureMeta.Builder

java.lang.Object

org.nuiton.db.meta.ImmutableProcedureMeta.Builder

Enclosing class:

ImmutableProcedureMeta

@NotThreadSafe
public static final class ImmutableProcedureMeta.Builder
extends Object

Builds instances of type ImmutableProcedureMeta. Initialize attributes and then invoke the build() method to create an immutable instance.

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

Method Summary

Modifier and Type	Method and Description
ImmutableProcedureMeta.Builder	args(Map<String,? extends String> entries) Sets or replaces all mappings from the specified map as entries for the args map.
ImmutableProcedureMeta	build() Builds a new ImmutableProcedureMeta.
ImmutableProcedureMeta.Builder	comment(Optional<String> comment) Initializes the optional value comment to comment.
ImmutableProcedureMeta.Builder	comment(String comment) Initializes the optional value comment to comment.
ImmutableProcedureMeta.Builder	from(ProcedureMeta instance) Fill a builder with attribute values from the provided ProcedureMeta instance.
ImmutableProcedureMeta.Builder	name(String name) Initializes the value for the name attribute.
ImmutableProcedureMeta.Builder	putAllArgs(Map<String,? extends String> entries) Put all mappings from the specified map as entries to args map.
ImmutableProcedureMeta.Builder	putArgs(Map.Entry<String,? extends String> entry) Put one entry to the args map.
ImmutableProcedureMeta.Builder	putArgs(String key, String value) Put one entry to the args map.

Methods inherited from class java.lang.Object

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

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableProcedureMeta.Builder from(ProcedureMeta instance)

Fill a builder with attribute values from the provided ProcedureMeta instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

name

@CanIgnoreReturnValue
public final ImmutableProcedureMeta.Builder name(String name)

Initializes the value for the name attribute.

Parameters:

name - The value for name

Returns:

this builder for use in a chained invocation

putArgs

@CanIgnoreReturnValue
public final ImmutableProcedureMeta.Builder putArgs(String key,
                                                                          String value)

Put one entry to the args map.

Parameters:

key - The key in the args map

value - The associated value in the args map

Returns:

this builder for use in a chained invocation

putArgs

@CanIgnoreReturnValue
public final ImmutableProcedureMeta.Builder putArgs(Map.Entry<String,? extends String> entry)

Put one entry to the args map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

args

@CanIgnoreReturnValue
public final ImmutableProcedureMeta.Builder args(Map<String,? extends String> entries)

Sets or replaces all mappings from the specified map as entries for the args map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the args map

Returns:

this builder for use in a chained invocation

putAllArgs

@CanIgnoreReturnValue
public final ImmutableProcedureMeta.Builder putAllArgs(Map<String,? extends String> entries)

Put all mappings from the specified map as entries to args map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the args map

Returns:

this builder for use in a chained invocation

comment

@CanIgnoreReturnValue
public final ImmutableProcedureMeta.Builder comment(String comment)

Initializes the optional value comment to comment.

Parameters:

comment - The value for comment

Returns:

this builder for chained invocation

comment

@CanIgnoreReturnValue
public final ImmutableProcedureMeta.Builder comment(Optional<String> comment)

Initializes the optional value comment to comment.

Parameters:

comment - The value for comment

Returns:

this builder for use in a chained invocation

build

public ImmutableProcedureMeta build()

Builds a new ImmutableProcedureMeta.

Returns:

An immutable instance of ProcedureMeta

Throws:

IllegalStateException - if any required attributes are missing