Package com.refinedmods.refinedstorage.api.resource.list

Class MutableResourceListImpl

java.lang.Object

com.refinedmods.refinedstorage.api.resource.list.MutableResourceListImpl

All Implemented Interfaces:

MutableResourceList, ResourceList

@API(status=STABLE,
     since="2.0.0-milestone.1.2")
public class MutableResourceListImpl
extends Object
implements MutableResourceList

An implementation of a ResourceList that stores the resource entries in memory.

Nested Class Summary

Nested classes/interfaces inherited from interface com.refinedmods.refinedstorage.api.resource.list.MutableResourceList

MutableResourceList.OperationResult

Method Summary

Modifier and Type	Method	Description
MutableResourceList.OperationResult	add(ResourceKey resource, long amount)	Adds a given resource to the list.
void	clear()	Clears the list.
boolean	contains(ResourceKey resource)
MutableResourceList	copy()	Copies the list.
Collection<ResourceAmount>	copyState()	Retrieves all resources and their amounts from the list.
static MutableResourceListImpl	create()
long	get(ResourceKey resource)
Set<ResourceKey>	getAll()
boolean	isEmpty()
static MutableResourceListImpl	orderPreserving()
MutableResourceList.OperationResult	remove(ResourceKey resource, long amount)	Removes as much of a certain amount of a resource in the list.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.refinedmods.refinedstorage.api.resource.list.MutableResourceList

add, remove

Method Details

create

public static MutableResourceListImpl create()

orderPreserving

public static MutableResourceListImpl orderPreserving()

add

public MutableResourceList.OperationResult add(ResourceKey resource,
 long amount)

Description copied from interface: MutableResourceList

Adds a given resource to the list.

Specified by:

add in interface MutableResourceList

Parameters:

resource - the resource, may not be null

amount - the amount, must be larger than 0

Returns:

the result of the operation

remove

@Nullable
public MutableResourceList.OperationResult remove(ResourceKey resource,
 long amount)

Description copied from interface: MutableResourceList

Removes as much of a certain amount of a resource in the list. If the amount reaches 0 due to this removal, the resource is removed from the list.

Specified by:

remove in interface MutableResourceList

Parameters:

resource - the resource, may not be null

amount - the amount, must be larger than 0

Returns:

a result if the removal operation was successful, otherwise null

copyState

public Collection<ResourceAmount> copyState()

Description copied from interface: ResourceList

Retrieves all resources and their amounts from the list.

Specified by:

copyState in interface ResourceList

Returns:

a list of resource amounts

getAll

public Set<ResourceKey> getAll()

Specified by:

getAll in interface ResourceList

Returns:

set of resources contained in this list

get

public long get(ResourceKey resource)

Specified by:

get in interface ResourceList

Parameters:

resource - the resource

Returns:

the amount stored, or zero if not stored

contains

public boolean contains(ResourceKey resource)

Specified by:

contains in interface ResourceList

Parameters:

resource - the resource

Returns:

whether the list contains this resource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ResourceList

Returns:

whether the list is empty

clear

public void clear()

Description copied from interface: MutableResourceList

Clears the list.

Specified by:

clear in interface MutableResourceList

copy

public MutableResourceList copy()

Description copied from interface: MutableResourceList

Copies the list.

Specified by:

copy in interface MutableResourceList

toString

public String toString()

Overrides:

toString in class Object