Package com.refinedmods.refinedstorage.api.storage

Class StateTrackedStorage

java.lang.Object

com.refinedmods.refinedstorage.api.storage.StateTrackedStorage

All Implemented Interfaces:

ExtractableStorage, InsertableStorage, LimitedStorage, Storage, StorageView, TrackedStorage

public class StateTrackedStorage
extends Object
implements TrackedStorage, LimitedStorage

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StateTrackedStorage.Listener

Constructor Summary

Constructors

Constructor	Description
StateTrackedStorage(Storage delegate, StateTrackedStorage.Listener listener)

Method Summary

Modifier and Type	Method	Description
static StorageState	computeState(long capacity, long stored)
long	extract(ResourceKey resource, long amount, Action action, Actor actor)	Extracts a resource from a storage.
Optional<TrackedResource>	findTrackedResourceByActorType(ResourceKey resource, Class<? extends Actor> actorType)	Finds the tracked resource by actor type.
Collection<ResourceAmount>	getAll()
long	getCapacity()
Storage	getDelegate()
StorageState	getState()
long	getStored()
long	insert(ResourceKey resource, long amount, Action action, Actor actor)	Inserts a resource into a storage.

Methods inherited from class java.lang.Object

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

Constructor Details

StateTrackedStorage

public StateTrackedStorage(Storage delegate,
 @Nullable
 StateTrackedStorage.Listener listener)

Method Details

getDelegate

public Storage getDelegate()

getState

public StorageState getState()

computeState

public static StorageState computeState(long capacity,
 long stored)

extract

public long extract(ResourceKey resource,
 long amount,
 Action action,
 Actor actor)

Description copied from interface: ExtractableStorage

Extracts a resource from a storage.

Specified by:

extract in interface ExtractableStorage

Parameters:

resource - the resource, may not be null

amount - the amount, must be larger than 0

action - the mode of extraction

actor - the source

Returns:

the amount extracted

insert

public long insert(ResourceKey resource,
 long amount,
 Action action,
 Actor actor)

Description copied from interface: InsertableStorage

Inserts a resource into a storage.

Specified by:

insert in interface InsertableStorage

Parameters:

resource - the resource, may not be null

amount - the amount, must be larger than 0

action - the mode of insertion

actor - the source

Returns:

the amount inserted

getAll

public Collection<ResourceAmount> getAll()

Specified by:

getAll in interface StorageView

Returns:

a list of resource amounts

getStored

public long getStored()

Specified by:

getStored in interface StorageView

Returns:

the amount stored

findTrackedResourceByActorType

public Optional<TrackedResource> findTrackedResourceByActorType(ResourceKey resource,
 Class<? extends Actor> actorType)

Description copied from interface: TrackedStorage

Finds the tracked resource by actor type.

Specified by:

findTrackedResourceByActorType in interface TrackedStorage

Parameters:

resource - the resource

actorType - the actor type

Returns:

the tracked resource modified by the given actor type, if present

getCapacity

public long getCapacity()

Specified by:

getCapacity in interface LimitedStorage