org.spongepowered.api.item.inventory.transaction

Class InventoryTransactionResult

java.lang.Object

org.spongepowered.api.item.inventory.transaction.InventoryTransactionResult

public final class InventoryTransactionResult
extends Object

An interface for data returned by inventory operations which encapsulates the result of an attempted operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InventoryTransactionResult.Builder
static class	InventoryTransactionResult.Type

Method Summary

Modifier and Type	Method and Description
static InventoryTransactionResult.Builder	builder() Begin building a new InventoryTransactionResult.
static InventoryTransactionResult	failNoTransactions() Returns a builder which indicates that the transaction failed, and the transaction result was no-op.
Collection<ItemStackSnapshot>	getRejectedItems() If items were supplied to the operation, this collection will return any items which were rejected by the target inventory.
Collection<ItemStackSnapshot>	getReplacedItems() If the operation replaced items in the inventory, this collection returns the ItemStacks which were replaced.
InventoryTransactionResult.Type	getType() Gets the type of result.
static InventoryTransactionResult	successNoTransactions() Returns a builder which indicates that the transaction succeeded, but the transaction result was no-op.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static InventoryTransactionResult.Builder builder()

Begin building a new InventoryTransactionResult.

Returns:

A new builder

successNoTransactions

public static InventoryTransactionResult successNoTransactions()

Returns a builder which indicates that the transaction succeeded, but the transaction result was no-op.

Returns:

A new transaction result

failNoTransactions

public static InventoryTransactionResult failNoTransactions()

Returns a builder which indicates that the transaction failed, and the transaction result was no-op.

Returns:

A new transaction result

getType

public InventoryTransactionResult.Type getType()

Gets the type of result.

Returns:

the type of result

getRejectedItems

public Collection<ItemStackSnapshot> getRejectedItems()

If items were supplied to the operation, this collection will return any items which were rejected by the target inventory.

Returns:

any items which were rejected as part of the inventory operation

getReplacedItems

public Collection<ItemStackSnapshot> getReplacedItems()

If the operation replaced items in the inventory, this collection returns the ItemStacks which were replaced.

Returns:

any items which were ejected as part of the inventory operation