Package com.refinedmods.refinedstorage.api.storage.composite

Class CompositeStorageImpl

java.lang.Object

com.refinedmods.refinedstorage.api.storage.composite.CompositeStorageImpl

All Implemented Interfaces:

CompositeAwareChild, CompositeStorage, ParentComposite, ExtractableStorage, InsertableStorage, Storage, StorageView, TrackedStorage

@API(status=STABLE,
     since="2.0.0-milestone.1.0")
public class CompositeStorageImpl
extends Object
implements CompositeStorage, CompositeAwareChild, ParentComposite

An implementation of CompositeStorage that can be contained into other CompositeStorages.

Nested Class Summary

Nested classes/interfaces inherited from interface com.refinedmods.refinedstorage.api.storage.composite.CompositeAwareChild

CompositeAwareChild.Amount

Constructor Summary

Constructors

Constructor	Description
CompositeStorageImpl(ResourceList list)

Method Summary

Modifier and Type	Method	Description
void	addSource(Storage source)	Adds a source and resorts them.
void	addToCache(ResourceKey resource, long amount)	Adds a resource to the composite storage cache.
void	clearSources()	Clears all sources.
CompositeAwareChild.Amount	compositeExtract(ResourceKey resource, long amount, Action action, Actor actor)	Extracts a resource from a storage.
CompositeAwareChild.Amount	compositeInsert(ResourceKey resource, long amount, Action action, Actor actor)	Inserts a resource into a storage.
boolean	contains(Storage storage)
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()
List<Storage>	getSources()
long	getStored()
long	insert(ResourceKey resource, long amount, Action action, Actor actor)	Inserts a resource into a storage.
void	onAddedIntoComposite(ParentComposite parentComposite)	Called by a CompositeStorage when this CompositeAwareChild is added into the composite storage.
void	onRemovedFromComposite(ParentComposite parentComposite)	Called by a CompositeStorage when this CompositeAwareChild is removed from the composite storage.
void	onSourceAddedToChild(Storage source)	Called by the CompositeAwareChild to notify to this parent composite storage that a source has been added.
void	onSourceRemovedFromChild(Storage source)	Called by the CompositeAwareChild to notify to this parent composite storage that a source has been removed.
void	removeFromCache(ResourceKey resource, long amount)	Removes a resource from the composite storage cache.
void	removeSource(Storage source)	Removes a source and resorts them.
void	sortSources()	Sorts storages that implement PriorityProvider.

Methods inherited from class java.lang.Object

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

Constructor Details

CompositeStorageImpl

public CompositeStorageImpl(ResourceList list)

Parameters:

list - the backing list of this composite storage, used to retrieve a view of the sources

Method Details

sortSources

public void sortSources()

Description copied from interface: CompositeStorage

Sorts storages that implement PriorityProvider.

Specified by:

sortSources in interface CompositeStorage

addSource

public void addSource(Storage source)

Description copied from interface: CompositeStorage

Adds a source and resorts them.

Specified by:

addSource in interface CompositeStorage

Parameters:

source - the source

removeSource

public void removeSource(Storage source)

Description copied from interface: CompositeStorage

Removes a source and resorts them.

Specified by:

removeSource in interface CompositeStorage

Parameters:

source - the source

getSources

public List<Storage> getSources()

Specified by:

getSources in interface CompositeStorage

Returns:

an unmodifiable source list

clearSources

public void clearSources()

Description copied from interface: CompositeStorage

Clears all sources.

Specified by:

clearSources in interface CompositeStorage

contains

public boolean contains(Storage storage)

Specified by:

contains in interface CompositeAwareChild

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

onAddedIntoComposite

public void onAddedIntoComposite(ParentComposite parentComposite)

Description copied from interface: CompositeAwareChild

Called by a CompositeStorage when this CompositeAwareChild is added into the composite storage.

Specified by:

onAddedIntoComposite in interface CompositeAwareChild

Parameters:

parentComposite - the composite storage that this CompositeAwareChild is contained in

onRemovedFromComposite

public void onRemovedFromComposite(ParentComposite parentComposite)

Description copied from interface: CompositeAwareChild

Called by a CompositeStorage when this CompositeAwareChild is removed from the composite storage.

Specified by:

onRemovedFromComposite in interface CompositeAwareChild

Parameters:

parentComposite - the composite storage that this CompositeAwareChild is/was contained in

compositeInsert

public CompositeAwareChild.Amount compositeInsert(ResourceKey resource,
 long amount,
 Action action,
 Actor actor)

Description copied from interface: CompositeAwareChild

Inserts a resource into a storage.

Specified by:

compositeInsert in interface CompositeAwareChild

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

compositeExtract

public CompositeAwareChild.Amount compositeExtract(ResourceKey resource,
 long amount,
 Action action,
 Actor actor)

Description copied from interface: CompositeAwareChild

Extracts a resource from a storage.

Specified by:

compositeExtract in interface CompositeAwareChild

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

onSourceAddedToChild

public void onSourceAddedToChild(Storage source)

Description copied from interface: ParentComposite

Called by the CompositeAwareChild to notify to this parent composite storage that a source has been added.

Specified by:

onSourceAddedToChild in interface ParentComposite

Parameters:

source - the source

onSourceRemovedFromChild

public void onSourceRemovedFromChild(Storage source)

Description copied from interface: ParentComposite

Called by the CompositeAwareChild to notify to this parent composite storage that a source has been removed.

Specified by:

onSourceRemovedFromChild in interface ParentComposite

Parameters:

source - the source

addToCache

public void addToCache(ResourceKey resource,
 long amount)

Description copied from interface: ParentComposite

Adds a resource to the composite storage cache.

Specified by:

addToCache in interface ParentComposite

Parameters:

resource - the resource

amount - the amount

removeFromCache

public void removeFromCache(ResourceKey resource,
 long amount)

Description copied from interface: ParentComposite

Removes a resource from the composite storage cache.

Specified by:

removeFromCache in interface ParentComposite

Parameters:

resource - the resource

amount - the amount