org.spongepowered.api.data

Class Transaction<T extends DataSerializable>

java.lang.Object

org.spongepowered.api.data.Transaction<T>

All Implemented Interfaces:

DataSerializable

Direct Known Subclasses:

SlotTransaction

public class Transaction<T extends DataSerializable>
extends Object
implements DataSerializable

Constructor Summary

Constructors

Constructor and Description
Transaction(T original, T defaultReplacement) Creates a new transaction.
Transaction(T original, T defaultReplacement, List<? extends T> intermediary) Creates a new Transaction with the added possibility of intermediary transactions that may have taken place between what is original and the default result.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getContentVersion() Gets the content version of this DataSerializable.
Optional<T>	getCustom() Gets the custom snapshot if one was set.
T	getDefault() Gets the default replacement snapshot.
T	getFinal() Gets the proposed final snapshot, if the getCustom() returns Optional.isPresent(), the custom is returned, otherwise, getDefault() is returned.
List<? extends T>	getIntermediary() Gets a List of any and all intermediary transactions that may have taken place to get the final Transaction of the original and the default results.
T	getOriginal() Gets the original snapshot.
int	hashCode()
boolean	isValid() Gets whether this transaction is marked as valid.
void	setCustom(T custom) Sets the custom snapshot.
void	setValid(boolean valid) Sets whether this transaction is valid or not.
DataContainer	toContainer() Serializes this object into a comprehensible DataContainer.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Transaction

public Transaction(T original,
                   T defaultReplacement)

Creates a new transaction.

Parameters:

original - The original object being replaced

defaultReplacement - The default replacement

Transaction

public Transaction(T original,
                   T defaultReplacement,
                   @Nullable
                   List<? extends T> intermediary)

Creates a new Transaction with the added possibility of intermediary transactions that may have taken place between what is original and the default result. The list may be null, however the list will wrapped to become an unmodifiable list.

It is imperative that the provided list is not to be modified outside this created Transaction synchronously and asynchronously as consumers of the provided list will not be able to react accordingly.

Parameters:

original -

defaultReplacement -

intermediary -

Method Detail

getOriginal

public final T getOriginal()

Gets the original snapshot.

Returns:

The original snapshot

getDefault

public final T getDefault()

Gets the default replacement snapshot.

Returns:

The default replacement

getIntermediary

public final List<? extends T> getIntermediary()

Gets a List of any and all intermediary transactions that may have taken place to get the final Transaction of the original and the default results. This is exposed for monitoring purposes only, as the provided list is not modifiable. The list may be empty by default, but will never be null.

Note that special processing with this list may sometimes only take place if a custom result has not been set by a plugin, or if isValid() returns false.

Returns:

The intermediary list of transactions

getCustom

public final Optional<T> getCustom()

Gets the custom snapshot if one was set.

Returns:

The custom snapshot, if available

setCustom

public final void setCustom(@Nullable
                            T custom)

Sets the custom snapshot. If setting null, this will reset to use the getDefault() snapshot.

Parameters:

custom - The custom snapshot

getFinal

public final T getFinal()

Gets the proposed final snapshot, if the getCustom() returns Optional.isPresent(), the custom is returned, otherwise, getDefault() is returned.

Returns:

The proposed final snapshot

isValid

public final boolean isValid()

Gets whether this transaction is marked as valid.

Returns:

The valid state of this transaction

setValid

public final void setValid(boolean valid)

Sets whether this transaction is valid or not.

Parameters:

valid - The valid state of this transaction

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getContentVersion

public int getContentVersion()

Description copied from interface: DataSerializable

Gets the content version of this DataSerializable. The version may differ between instances of plugins and implementations such that the DataView from DataSerializable.toContainer() may include different information, or remove other information as they are no longer deemed necessary. The version goes hand in hand with DataContentUpdater as it is required when there exists any DataView of this DataSerializable with an "older" version.

Specified by:

getContentVersion in interface DataSerializable

Returns:

The version of the content being serialized

toContainer

public DataContainer toContainer()

Description copied from interface: DataSerializable

Serializes this object into a comprehensible DataContainer.

Specified by:

toContainer in interface DataSerializable

Returns:

A newly created DataContainer