DataTransactionResult (SpongeAPI 7.3.0 API)

java.lang.Object
- org.spongepowered.api.data.DataTransactionResult

```
public final class DataTransactionResult
extends Object
```
Represents a transaction taking place where a DataHolder is accepting DataManipulators.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataTransactionResult.Builder` A type of builder for building `DataTransactionResult`s.
`static class`	`DataTransactionResult.Type` The type of transaction result.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static DataTransactionResult.Builder`	`builder()` Gets a new `DataTransactionResult.Builder` to build a new `DataTransactionResult`.
`boolean`	`equals(Object o)`
`static DataTransactionResult`	`errorResult(ImmutableValue<?> value)` Creates a new `DataTransactionResult` that ends in failure.
`static DataTransactionResult`	`failNoData()` Creates a new `DataTransactionResult` that ends in failure.
`static DataTransactionResult`	`failResult(ImmutableValue<?> value)` Creates a new `DataTransactionResult` that ends in failure.
`static DataTransactionResult`	`failResult(Iterable<ImmutableValue<?>> values)` Creates a new `DataTransactionResult` that ends in failure.
`List<ImmutableValue<?>>`	`getRejectedData()` If `Value`s were supplied to the operation, this collection will return any `ImmutableValue`s which were rejected by the target `DataHolder`.
`List<ImmutableValue<?>>`	`getReplacedData()` If the operation replaced any `Value`s, this returns a collection of the replaced `ImmutableValue`s.
`List<ImmutableValue<?>>`	`getSuccessfulData()` If any `BaseValue`s applied onto a `CompositeValueStore` were successful, they'll be stored in the given list.
`DataTransactionResult.Type`	`getType()` Gets the type of result.
`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<ImmutableValue<?>>> consumer)` If this result of `isSuccessful()` returns `true`, the provided `Consumer` is called provided a list of all "successful" data as retrieved from `getSuccessfulData()`.
`void`	`ifSucessful(Consumer<List<ImmutableValue<?>>> consumer)` Deprecated. Use `ifSuccessful(Consumer)` instead
`boolean`	`isSuccessful()` Gets whether this `DataTransactionResult` was successful or not.
`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<ImmutableValue<?>> removed)` Creates a `DataTransactionResult` with the provided `ImmutableValue`s being successfully removed.
`static DataTransactionResult`	`successRemove(ImmutableValue<?> removed)` Creates a `DataTransactionResult` with the provided `ImmutableValue` being successfully removed.
`static DataTransactionResult`	`successReplaceResult(Collection<ImmutableValue<?>> successful, Collection<ImmutableValue<?>> replaced)` Creates a new `DataTransactionResult` with the provided `ImmutableValue`s being the successful additions and the provided `ImmutableValue`s that were replaced.
`static DataTransactionResult`	`successReplaceResult(ImmutableValue<?> successful, ImmutableValue<?> replaced)` Creates a new `DataTransactionResult` with the provided `ImmutableValue` being the successful addition.
`static DataTransactionResult`	`successResult(ImmutableValue<?> value)` Creates a new `DataTransactionResult` with the provided `ImmutableValue` being the successful addition.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - 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(ImmutableValue<?> value)
```
    Creates a new DataTransactionResult with the provided ImmutableValue being the successful addition. The result type is still DataTransactionResult.Type.SUCCESS. If a Value is necessary, use Value.asImmutable() to use this method. A DataTransactionResult is always immutable once created, and any BaseValues should be provided as ImmutableValues or transformed into ImmutableValues.
    
    Parameters:
    
    value - The successfully added immutable value
    
    Returns:
    
    The new data transaction result
  - successReplaceResult
```
public static DataTransactionResult successReplaceResult(ImmutableValue<?> successful,
                                                         ImmutableValue<?> replaced)
```
    Creates a new DataTransactionResult with the provided ImmutableValue being the successful addition. The result type is still DataTransactionResult.Type.SUCCESS. If a Value is necessary, use Value.asImmutable() to use this method. A DataTransactionResult is always immutable once created, and any BaseValues should be provided as ImmutableValues or transformed into ImmutableValues.
    
    Parameters:
    
    successful - The successfully added immutable value
    
    replaced - The replaced value
    
    Returns:
    
    The new data transaction result
  - successReplaceResult
```
public static DataTransactionResult successReplaceResult(Collection<ImmutableValue<?>> successful,
                                                         Collection<ImmutableValue<?>> replaced)
```
    Creates a new DataTransactionResult with the provided ImmutableValues being the successful additions and the provided ImmutableValues that were replaced. The result type is still DataTransactionResult.Type.SUCCESS. If a Value is necessary, use Value.asImmutable() to use this method. A DataTransactionResult is always immutable once created, and any BaseValues should be provided as ImmutableValues or transformed into ImmutableValues.
    
    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<ImmutableValue<?>> removed)
```
    Creates a DataTransactionResult with the provided ImmutableValues being successfully removed. The result type is still DataTransactionResult.Type.SUCCESS. If a Value is necessary, use Value.asImmutable() to use this method. A DataTransactionResult is always immutable once created, and any BaseValues should be provided as ImmutableValues or transformed into ImmutableValues.
    
    Parameters:
    
    removed - The successfully removed values
    
    Returns:
    
    The new data transaction result
  - successRemove
```
public static DataTransactionResult successRemove(ImmutableValue<?> removed)
```
    Creates a DataTransactionResult with the provided ImmutableValue being successfully removed. The result type is still DataTransactionResult.Type.SUCCESS. If a Value is necessary, use Value.asImmutable() to use this method. A DataTransactionResult is always immutable once created, and a BaseValue should be provided as an ImmutableValue or transformed into an ImmutableValue.
    
    Parameters:
    
    removed - The successfully removed value
    
    Returns:
    
    The new data transaction result
  - failResult
```
public static DataTransactionResult failResult(ImmutableValue<?> value)
```
    Creates a new DataTransactionResult that ends in failure. The provided ImmutableValue 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<ImmutableValue<?>> values)
```
    Creates a new DataTransactionResult that ends in failure. The provided ImmutableValues 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(ImmutableValue<?> value)
```
    Creates a new DataTransactionResult that ends in failure. The provided ImmutableValue is considered "incompatible" and was not successfully added.
    
    Parameters:
    
    value - The value that was incompatible or errored
    
    Returns:
    
    The new data transaction result
  - getType
```
public DataTransactionResult.Type getType()
```
    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
  - getSuccessfulData
```
public List<ImmutableValue<?>> getSuccessfulData()
```
    If any BaseValues applied onto a CompositeValueStore were successful, they'll be stored in the given list.
    
    Returns:
    
    An immutable list of the values successfully offered
  - getRejectedData
```
public List<ImmutableValue<?>> getRejectedData()
```
    If Values were supplied to the operation, this collection will return any ImmutableValues which were rejected by the target DataHolder.
    
    Returns:
    
    Any data that was rejected from the operation
  - getReplacedData
```
public List<ImmutableValue<?>> getReplacedData()
```
    If the operation replaced any Values, this returns a collection of the replaced ImmutableValues.
    
    Returns:
    
    Any data that was replaced
  - ifSuccessful
```
public void ifSuccessful(Consumer<List<ImmutableValue<?>>> consumer)
```
    If this result of isSuccessful() returns true, the provided Consumer is called provided a list of all "successful" data as retrieved from getSuccessfulData().
    
    Parameters:
    
    consumer - The consumer to call
  - ifSucessful
```
@Deprecated
public void ifSucessful(Consumer<List<ImmutableValue<?>>> consumer)
```
    Deprecated. Use ifSuccessful(Consumer) instead
    
    If this result of isSuccessful() returns true, the provided Consumer is called provided a list of all "successful" data as retrieved from getSuccessfulData().
    
    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(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class DataTransactionResult

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

successNoData

successResult

successReplaceResult

successReplaceResult

successRemove

successRemove

failResult

failResult

failNoData

errorResult

getType

isSuccessful

getSuccessfulData

getRejectedData

getReplacedData

ifSuccessful

ifSucessful

ifNotSuccessful

toString

equals

hashCode