ch.ralscha.extdirectspring.bean

Class EdStoreResult.Builder<T>

java.lang.Object

ch.ralscha.extdirectspring.bean.EdStoreResult.Builder<T>

Enclosing class:

EdStoreResult<T>

public static final class EdStoreResult.Builder<T>
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ch.ralscha.extdirectspring.bean.ImmutableEdStoreResult<T>	build() Builds a new ImmutableEdStoreResult.
EdStoreResult.Builder<T>	from(EdStoreResult<T> instance) Fill a builder with attribute values from the provided EdStoreResult instance.
EdStoreResult.Builder<T>	message(String message) Initializes the value for the message attribute.
EdStoreResult.Builder<T>	metaData(Map<String,? extends Object> metaData) Sets or replaces all mappings from the specified map as entries for the metaData map.
EdStoreResult.Builder<T>	putAllMetaData(Map<String,? extends Object> metaData) Put all mappings from the specified map as entries to metaData map.
EdStoreResult.Builder<T>	putMetaData(Map.Entry<String,? extends Object> entry) Put one entry to the metaData map.
EdStoreResult.Builder<T>	putMetaData(String key, Object value) Put one entry to the metaData map.
EdStoreResult.Builder<T>	records(Collection<T> records) Initializes the value for the records attribute.
EdStoreResult.Builder<T>	success(Boolean success) Initializes the value for the success attribute.
EdStoreResult.Builder<T>	total(Long total) Initializes the value for the total attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

from

public final EdStoreResult.Builder<T> from(EdStoreResult<T> instance)

Fill a builder with attribute values from the provided EdStoreResult 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

records

public final EdStoreResult.Builder<T> records(Collection<T> records)

Initializes the value for the records attribute.

Parameters:

records - The value for records

Returns:

this builder for use in a chained invocation

total

public final EdStoreResult.Builder<T> total(Long total)

Initializes the value for the total attribute.

Parameters:

total - The value for total (can be null)

Returns:

this builder for use in a chained invocation

success

public final EdStoreResult.Builder<T> success(Boolean success)

Initializes the value for the success attribute.

Parameters:

success - The value for success (can be null)

Returns:

this builder for use in a chained invocation

putMetaData

public final EdStoreResult.Builder<T> putMetaData(String key,
                                                  Object value)

Put one entry to the metaData map.

Parameters:

key - The key in the metaData map

value - The associated value in the metaData map

Returns:

this builder for use in a chained invocation

putMetaData

public final EdStoreResult.Builder<T> putMetaData(Map.Entry<String,? extends Object> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

metaData

public final EdStoreResult.Builder<T> metaData(Map<String,? extends Object> metaData)

Sets or replaces all mappings from the specified map as entries for the metaData map. Nulls are not permitted as keys or values, but parameter itself can be null

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllMetaData

public final EdStoreResult.Builder<T> putAllMetaData(Map<String,? extends Object> metaData)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

message

public final EdStoreResult.Builder<T> message(String message)

Initializes the value for the message attribute.

Parameters:

message - The value for message (can be null)

Returns:

this builder for use in a chained invocation

build

public ch.ralscha.extdirectspring.bean.ImmutableEdStoreResult<T> build()

Builds a new ImmutableEdStoreResult.

Returns:

An immutable instance of EdStoreResult

Throws:

IllegalStateException - if any required attributes are missing