Package com.refinedmods.refinedstorage.api.storage

Class StorageImpl

java.lang.Object

com.refinedmods.refinedstorage.api.storage.StorageImpl

All Implemented Interfaces:

ExtractableStorage, InsertableStorage, Storage, StorageView

@API(status=STABLE,
     since="2.0.0-milestone.1.0")
public class StorageImpl
extends Object
implements Storage

An implementation of a Storage which has a resource list as a backing list.

Constructor Summary

Constructors

Constructor	Description
StorageImpl()
StorageImpl(MutableResourceList list)

Method Summary

Modifier and Type	Method	Description
long	extract(ResourceKey resource, long amount, Action action, Actor actor)	Extracts a resource from a storage.
Collection<ResourceAmount>	getAll()
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

StorageImpl

public StorageImpl(MutableResourceList list)

StorageImpl

public StorageImpl()

Method Details

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