org.spongepowered.api.data

Class DataTransactionResult.Builder

java.lang.Object

org.spongepowered.api.data.DataTransactionResult.Builder

All Implemented Interfaces:

ResettableBuilder<DataTransactionResult,DataTransactionResult.Builder>

Enclosing class:

DataTransactionResult

public static final class DataTransactionResult.Builder
extends Object
implements ResettableBuilder<DataTransactionResult,DataTransactionResult.Builder>

A type of builder for building DataTransactionResults. The common use is for both implementations of DataHolders, and various ChangeDataHolderEvent.ValueChanges.

Method Summary

Modifier and Type	Method and Description
DataTransactionResult.Builder	absorbResult(DataTransactionResult result) Combines the currently building DataTransactionResult with the one provided.
DataTransactionResult	build() Builds a new DataTransactionResult with the providing Lists of ImmutableValues that are successfully offered, ImmutableValues that were replaced, and ImmutableValues that were rejected.
DataTransactionResult.Builder	from(DataTransactionResult value) Resets this builder to the values of the given built object.
DataTransactionResult.Builder	reject(ImmutableValue<?> value) Adds the provided ImmutableValue to the List of "rejected" ImmutableValues.
DataTransactionResult.Builder	reject(Iterable<ImmutableValue<?>> values) Adds the provided ImmutableValues to the List of "rejected" ImmutableValues.
DataTransactionResult.Builder	replace(ImmutableValue<?> value) Adds the provided ImmutableValue to the List of "replaced" ImmutableValues.
DataTransactionResult.Builder	replace(Iterable<ImmutableValue<?>> values) Adds the provided ImmutableValues to the List of "replaced" ImmutableValues.
DataTransactionResult.Builder	reset() Resets this builder to a "default" state such that there is no remaining data to set.
DataTransactionResult.Builder	result(DataTransactionResult.Type type) Sets the expectant DataTransactionResult.Type to the provided type.
DataTransactionResult.Builder	success(ImmutableValue<?> value) Adds the provided ImmutableValue to the List of "successful" ImmutableValues.
DataTransactionResult.Builder	success(Iterable<ImmutableValue<?>> values) Adds the provided ImmutableValues to the List of "successful" ImmutableValues.

Methods inherited from class java.lang.Object

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

Method Detail

result

public DataTransactionResult.Builder result(DataTransactionResult.Type type)

Sets the expectant DataTransactionResult.Type to the provided type. A DataTransactionResult must always have a type to mark the transaction a "success" or "failure".

Parameters:

type - The type of the transaction result

Returns:

This builder, for chaining

replace

public DataTransactionResult.Builder replace(ImmutableValue<?> value)

Adds the provided ImmutableValue to the List of "replaced" ImmutableValues. The replaced values are always copied for every DataTransactionResult for referencing. It is also possible to retrieve these replaced ImmutableValues to CompositeValueStore.undo(DataTransactionResult) at a later point in the lifespan of the DataHolder.

Parameters:

value - The value to replace

Returns:

This builder, for chaining

replace

public DataTransactionResult.Builder replace(Iterable<ImmutableValue<?>> values)

Adds the provided ImmutableValues to the List of "replaced" ImmutableValues. The replaced values are always copied for every DataTransactionResult for referencing. It is also possible to retrieve these replaced ImmutableValues to CompositeValueStore.undo(DataTransactionResult) at a later point in the lifespan of the DataHolder.

Parameters:

values - The values to replace

Returns:

This builder, for chaining

reject

public DataTransactionResult.Builder reject(ImmutableValue<?> value)

Adds the provided ImmutableValue to the List of "rejected" ImmutableValues. The rejected values are always copied for every DataTransactionResult for referencing. It is also possible to retrieve these rejected ImmutableValues to CompositeValueStore.undo(DataTransactionResult) at a later point in the lifespan of the DataHolder.

Parameters:

value - The values to reject

Returns:

This builder, for chaining

reject

public DataTransactionResult.Builder reject(Iterable<ImmutableValue<?>> values)

Adds the provided ImmutableValues to the List of "rejected" ImmutableValues. The rejected values are always copied for every DataTransactionResult for referencing. It is also possible to retrieve these rejected ImmutableValues to CompositeValueStore.undo(DataTransactionResult) at a later point in the lifespan of the DataHolder.

Parameters:

values - The values to reject

Returns:

This builder, for chaining

success

public DataTransactionResult.Builder success(ImmutableValue<?> value)

Adds the provided ImmutableValue to the List of "successful" ImmutableValues. The successful values are always copied for every DataTransactionResult for referencing. It is also possible to retrieve these successful ImmutableValues to CompositeValueStore.undo(DataTransactionResult) at a later point in the lifespan of the DataHolder.

Parameters:

value - The value that was successfully provided

Returns:

This builder, for chaining

success

public DataTransactionResult.Builder success(Iterable<ImmutableValue<?>> values)

Adds the provided ImmutableValues to the List of "successful" ImmutableValues. The rejected values are always copied for every DataTransactionResult for referencing. It is also possible to retrieve these successful ImmutableValues to CompositeValueStore.undo(DataTransactionResult) at a later point in the lifespan of the DataHolder.

Parameters:

values - The values that were successfully provided

Returns:

This builder, for chaining

absorbResult

public DataTransactionResult.Builder absorbResult(DataTransactionResult result)

Combines the currently building DataTransactionResult with the one provided. Usually, this means that there is some merging of the ImmutableValues based on Key. If this builder already has an ImmutableValue as being successfully offered, and the provided result shows the same key as being rejected, the rejected ImmutableValue will remain in the final result.

Parameters:

result - The result to merge

Returns:

This builder, for chaining

build

public DataTransactionResult build()

Builds a new DataTransactionResult with the providing Lists of ImmutableValues that are successfully offered, ImmutableValues that were replaced, and ImmutableValues that were rejected.

Returns:

The newly created transaction result

from

public DataTransactionResult.Builder from(DataTransactionResult value)

Description copied from interface: ResettableBuilder

Resets this builder to the values of the given built object.

Specified by:

from in interface ResettableBuilder<DataTransactionResult,DataTransactionResult.Builder>

Parameters:

value - The built object

Returns:

This builder, for chaining

reset

public DataTransactionResult.Builder reset()

Description copied from interface: ResettableBuilder

Resets this builder to a "default" state such that there is no remaining data to set. This is to be the presumed "default" state.

Specified by:

reset in interface ResettableBuilder<DataTransactionResult,DataTransactionResult.Builder>

Returns:

This builder, for chaining