Package org.spongepowered.api.event.block

Interface ChangeBlockEvent.All

All Superinterfaces:

Cancellable, ChangeBlockEvent, Event

Enclosing interface:

ChangeBlockEvent

public static interface ChangeBlockEvent.All
extends ChangeBlockEvent, Cancellable

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.event.block.ChangeBlockEvent

ChangeBlockEvent.All, ChangeBlockEvent.Post, ChangeBlockEvent.Pre

Method Summary

Modifier and Type	Method	Description
default java.util.List<BlockTransaction>	invalidate(java.util.function.Predicate<ServerLocation> predicate)	Applies the provided Predicate to the List of Transactions from transactions() such that any time that Predicate.test(Object) returns false on the location of the Transaction, the Transaction is marked as "invalid" and will not apply post event.
default void	invalidateAll()	Invalidates the list as such that all Transactions are marked as "invalid" and will not apply post event.
java.util.List<BlockTransaction>	transactions()	Gets a list of the Transactions for this event.
default java.util.stream.Stream<BlockTransaction>	transactions(Operation operation)	Gets a Stream of BlockTransactions filtered by a particular block operation.

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Methods inherited from interface org.spongepowered.api.event.block.ChangeBlockEvent

world

Methods inherited from interface org.spongepowered.api.event.Event

cause, context, source

Method Detail

transactions

java.util.List<BlockTransaction> transactions()

Gets a list of the Transactions for this event. If a transaction is requested to be marked as "invalid", Transaction.setValid(boolean) can be used.

Returns:

The unmodifiable list of transactions

transactions

default java.util.stream.Stream<BlockTransaction> transactions(Operation operation)

Gets a Stream of BlockTransactions filtered by a particular block operation. The difference between this and transactions() is that while the general transactions is still an ordered List, this is a filtered stream of that list, equally unmodifiable. The transactions themselves are still modifiable with BlockTransaction#setCustom(BlockSnapshot), but altering the customized snapshot will NOT alter the Operation being performed. As a logical perspective, there is no functional difference between any two operations, but it can be important to differentiate between the two in some contexts.

Parameters:

operation - The operation being performed

Returns:

The stream filtering on the given operation, may be empty

invalidate

default java.util.List<BlockTransaction> invalidate(java.util.function.Predicate<ServerLocation> predicate)

Applies the provided Predicate to the List of Transactions from transactions() such that any time that Predicate.test(Object) returns false on the location of the Transaction, the Transaction is marked as "invalid" and will not apply post event.

Transaction.original() is used to get the ServerLocation

Parameters:

predicate - The predicate to use for filtering

Returns:

The transactions for which the predicate returned false

invalidateAll

default void invalidateAll()

Invalidates the list as such that all Transactions are marked as "invalid" and will not apply post event.