Package org.spongepowered.api.data

Class DataTransactionResult

java.lang.Object

org.spongepowered.api.data.DataTransactionResult

public final class DataTransactionResult
extends Object

Represents a transaction taking place where a DataHolder.Mutable is accepting Values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataTransactionResult.Builder	A type of builder for building DataTransactionResults.
static class	DataTransactionResult.Type	The type of transaction result.

Method Summary

Modifier and Type	Method	Description
static DataTransactionResult.Builder	builder()	Gets a new DataTransactionResult.Builder to build a new DataTransactionResult.
boolean	equals(@Nullable Object o)
static DataTransactionResult	errorResult(Value.Immutable<?> value)	Creates a new DataTransactionResult that ends in failure.
static DataTransactionResult	failNoData()	Creates a new DataTransactionResult that ends in failure.
static DataTransactionResult	failResult(Iterable<Value.Immutable<?>> values)	Creates a new DataTransactionResult that ends in failure.
static DataTransactionResult	failResult(Value.Immutable<?> value)	Creates a new DataTransactionResult that ends in failure.
int	hashCode()
<E extends Exception> void	ifNotSuccessful(Supplier<E> supplier)	Used to call a Supplier for an Exception of type E such that if this transaction's isSuccessful() returns false, the supplier's exception is thrown.
void	ifSuccessful(Consumer<List<Value.Immutable<?>>> consumer)	If this result of isSuccessful() returns true, the provided Consumer is called provided a list of all "successful" data as retrieved from successfulData().
boolean	isSuccessful()	Gets whether this DataTransactionResult was successful or not.
List<Value.Immutable<?>>	rejectedData()	If Value.Mutables were supplied to the operation, this collection will return any Value.Immutables which were rejected by the target DataHolder.
<T,V extends Value<T>> Optional<Value.Immutable<T>>	rejectedValue(Key<V> key)	Gets the rejected Value based on the provided Key.
List<Value.Immutable<?>>	replacedData()	If the operation replaced any Value.Mutables, this returns a collection of the replaced Value.Immutables.
<T,V extends Value<T>> Optional<Value.Immutable<T>>	replacedValue(Key<V> key)	Gets the replaced Value based on the provided Key.
List<Value.Immutable<?>>	successfulData()	If any Values applied onto a DataHolder were successful, they'll be stored in the given list.
<T,V extends Value<T>> Optional<Value.Immutable<T>>	successfulValue(Key<V> key)	Gets the successfully applied Value based on the provided Key.
static DataTransactionResult	successNoData()	Creates a DataTransactionResult with no data successfully added, removed, or rejected, and with the DataTransactionResult.Type of DataTransactionResult.Type.SUCCESS result type.
static DataTransactionResult	successRemove(Collection<Value.Immutable<?>> removed)	Creates a DataTransactionResult with the provided Value.Immutables being successfully removed.
static DataTransactionResult	successRemove(Value.Immutable<?> removed)	Creates a DataTransactionResult with the provided Value.Immutable being successfully removed.
static DataTransactionResult	successReplaceResult(Collection<Value.Immutable<?>> successful, Collection<Value.Immutable<?>> replaced)	Creates a new DataTransactionResult with the provided Value.Immutables being the successful additions and the provided Value.Immutables that were replaced.
static DataTransactionResult	successReplaceResult(Value.Immutable<?> successful, Value.Immutable<?> replaced)	Creates a new DataTransactionResult with the provided Value.Immutable being the successful addition.
static DataTransactionResult	successResult(Value.Immutable<?> value)	Creates a new DataTransactionResult with the provided Value.Immutable being the successful addition.
String	toString()
static Collector<DataTransactionResult,DataTransactionResult.Builder,DataTransactionResult>	toTransaction()
DataTransactionResult.Type	type()	Gets the type of result.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

toTransaction

public static Collector<DataTransactionResult,DataTransactionResult.Builder,DataTransactionResult> toTransaction()

builder

public static DataTransactionResult.Builder builder()

Gets a new DataTransactionResult.Builder to build a new DataTransactionResult.

Returns:

The new builder, for chaining

successNoData

public static DataTransactionResult successNoData()

Creates a DataTransactionResult with no data successfully added, removed, or rejected, and with the DataTransactionResult.Type of DataTransactionResult.Type.SUCCESS result type.

Returns:

A clean and empty data transaction

successResult

public static DataTransactionResult successResult(Value.Immutable<?> value)

Creates a new DataTransactionResult with the provided Value.Immutable being the successful addition. The result type is still DataTransactionResult.Type.SUCCESS. If a Value.Mutable is necessary, use Value.Mutable#asImmutable()} to use this method. A DataTransactionResult is always immutable once created, and any Values should be provided as Value.Immutables or transformed into Value.Immutables.

Parameters:

value - The successfully added immutable value

Returns:

The new data transaction result

successReplaceResult

public static DataTransactionResult successReplaceResult(Value.Immutable<?> successful,
                                                         Value.Immutable<?> replaced)

Creates a new DataTransactionResult with the provided Value.Immutable being the successful addition. The result type is still DataTransactionResult.Type.SUCCESS. If a Value.Mutable is necessary, use Value.Mutable#asImmutable()} to use this method. A DataTransactionResult is always immutable once created, and any Values should be provided as Value.Immutables or transformed into Value.Immutables.

Parameters:

successful - The successfully added immutable value

replaced - The replaced value

Returns:

The new data transaction result

successReplaceResult

public static DataTransactionResult successReplaceResult(Collection<Value.Immutable<?>> successful,
                                                         Collection<Value.Immutable<?>> replaced)

Creates a new DataTransactionResult with the provided Value.Immutables being the successful additions and the provided Value.Immutables that were replaced. The result type is still DataTransactionResult.Type.SUCCESS. If a Value.Mutable is necessary, use Value.Mutable#asImmutable()} to use this method. A DataTransactionResult is always immutable once created, and any Values should be provided as Value.Immutables or transformed into Value.Immutables.

Parameters:

successful - The successfully added immutable values

replaced - The successfully replaced immutable values

Returns:

The new data transaction result

successRemove

public static DataTransactionResult successRemove(Collection<Value.Immutable<?>> removed)

Creates a DataTransactionResult with the provided Value.Immutables being successfully removed. The result type is still DataTransactionResult.Type.SUCCESS. If a Value.Mutable is necessary, use Value.Mutable#asImmutable()} to use this method. A DataTransactionResult is always immutable once created, and any Values should be provided as Value.Immutables or transformed into Value.Immutables.

Parameters:

removed - The successfully removed values

Returns:

The new data transaction result

successRemove

public static DataTransactionResult successRemove(Value.Immutable<?> removed)

Creates a DataTransactionResult with the provided Value.Immutable being successfully removed. The result type is still DataTransactionResult.Type.SUCCESS. If a Value.Mutable is necessary, use Value.Mutable#asImmutable()} to use this method. A DataTransactionResult is always immutable once created, and a Value should be provided as an Value.Immutable or transformed into an Value.Immutable.

Parameters:

removed - The successfully removed value

Returns:

The new data transaction result

failResult

public static DataTransactionResult failResult(Value.Immutable<?> value)

Creates a new DataTransactionResult that ends in failure. The provided Value.Immutable is considered "rejected" and was not successfully added.

Parameters:

value - The value that was rejected

Returns:

The new data transaction result

failResult

public static DataTransactionResult failResult(Iterable<Value.Immutable<?>> values)

Creates a new DataTransactionResult that ends in failure. The provided Value.Immutables are considered "rejected" and were not successfully added.

Parameters:

values - The values that were rejected

Returns:

The new data transaction result

failNoData

public static DataTransactionResult failNoData()

Creates a new DataTransactionResult that ends in failure. There is no additional data to include.

Returns:

The new data transaction result

errorResult

public static DataTransactionResult errorResult(Value.Immutable<?> value)

Creates a new DataTransactionResult that ends in failure. The provided Value.Immutable is considered "incompatible" and was not successfully added.

Parameters:

value - The value that was incompatible or errored

Returns:

The new data transaction result

type

public DataTransactionResult.Type type()

Gets the type of result.

Returns:

the type of result

isSuccessful

public boolean isSuccessful()

Gets whether this DataTransactionResult was successful or not.

Returns:

True if this result was successful

successfulData

public List<Value.Immutable<?>> successfulData()

If any Values applied onto a DataHolder were successful, they'll be stored in the given list.

Returns:

An immutable list of the values successfully offered

successfulValue

public <T,V extends Value<T>> Optional<Value.Immutable<T>> successfulValue(Key<V> key)

Gets the successfully applied Value based on the provided Key.

Type Parameters:

T - The data type

V - The value type

Parameters:

key - The key

Returns:

The value, if available

rejectedData

public List<Value.Immutable<?>> rejectedData()

If Value.Mutables were supplied to the operation, this collection will return any Value.Immutables which were rejected by the target DataHolder.

Returns:

Any data that was rejected from the operation

rejectedValue

public <T,V extends Value<T>> Optional<Value.Immutable<T>> rejectedValue(Key<V> key)

Gets the rejected Value based on the provided Key.

Type Parameters:

T - The data type

V - The value type

Parameters:

key - The key

Returns:

The value, if available

replacedData

public List<Value.Immutable<?>> replacedData()

If the operation replaced any Value.Mutables, this returns a collection of the replaced Value.Immutables.

Returns:

Any data that was replaced

replacedValue

public <T,V extends Value<T>> Optional<Value.Immutable<T>> replacedValue(Key<V> key)

Gets the replaced Value based on the provided Key.

Type Parameters:

T - The data type

V - The value type

Parameters:

key - The key

Returns:

The value, if available

ifSuccessful

public void ifSuccessful(Consumer<List<Value.Immutable<?>>> consumer)

If this result of isSuccessful() returns true, the provided Consumer is called provided a list of all "successful" data as retrieved from successfulData().

Parameters:

consumer - The consumer to call

ifNotSuccessful

public <E extends Exception> void ifNotSuccessful(Supplier<E> supplier)
                                           throws E extends Exception

Used to call a Supplier for an Exception of type E such that if this transaction's isSuccessful() returns false, the supplier's exception is thrown.

Type Parameters:

E - The type of exception

Parameters:

supplier - The supplier of the exception to throw

Throws:

E - The exception to throw if this transaction is not successful

E extends Exception

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object