Package org.spongepowered.api.block.transaction

Class BlockTransaction

java.lang.Object

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

org.spongepowered.api.block.transaction.BlockTransaction

All Implemented Interfaces:

DataSerializable

public final class BlockTransaction
extends Transaction<BlockSnapshot>

A specialized Transaction<BlockSnapshot> that covers the required changes of one BlockSnapshot to another, with the added benefit of a contextual understanding of what sort of operation is being performed to change from one block to another. It is possible to serialize a particular transaction, but to associate a transaction with it's "post" state, refer to the receipt variant that exposes only what was and what is the final result.

Constructor Summary

Constructors

Constructor	Description
BlockTransaction(BlockSnapshot original, BlockSnapshot defaultReplacement, @Nullable List<? extends BlockSnapshot> intermediary, Operation operation)
BlockTransaction(BlockSnapshot original, BlockSnapshot defaultReplacement, Operation operation)

Method Summary

Modifier and Type	Method	Description
int	contentVersion()	Gets the content version of this DataSerializable.
boolean	equals(Object obj)
int	hashCode()
Operation	operation()
DataContainer	toContainer()	Serializes this object into a comprehensible DataContainer.
String	toString()

Methods inherited from class org.spongepowered.api.data.Transaction

custom, defaultReplacement, finalReplacement, intermediary, invalidate, isValid, original, setCustom, setValid, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockTransaction

public BlockTransaction(BlockSnapshot original,
                        BlockSnapshot defaultReplacement,
                        Operation operation)

BlockTransaction

public BlockTransaction(BlockSnapshot original,
                        BlockSnapshot defaultReplacement,
                        @Nullable List<? extends BlockSnapshot> intermediary,
                        Operation operation)

Method Detail

operation

public Operation operation()

hashCode

public int hashCode()

Overrides:

hashCode in class Transaction<BlockSnapshot>

equals

public boolean equals(Object obj)

Overrides:

equals in class Transaction<BlockSnapshot>

toString

public String toString()

Overrides:

toString in class Transaction<BlockSnapshot>

contentVersion

public int contentVersion()

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:

contentVersion in interface DataSerializable

Overrides:

contentVersion in class Transaction<BlockSnapshot>

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

Overrides:

toContainer in class Transaction<BlockSnapshot>

Returns:

A newly created DataContainer