Package com.refinedmods.refinedstorage.api.storage.external

Class ExternalStorage

java.lang.Object

com.refinedmods.refinedstorage.api.storage.external.ExternalStorage

All Implemented Interfaces:

CompositeAwareChild, ExtractableStorage, InsertableStorage, Storage, StorageView

@API(status=STABLE,
     since="2.0.0-milestone.2.4")
public class ExternalStorage
extends Object
implements CompositeAwareChild

Nested Class Summary

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

CompositeAwareChild.Amount

Constructor Summary

Constructors

Constructor	Description
ExternalStorage(ExternalStorageProvider provider, ExternalStorageListener listener)

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.refinedmods.refinedstorage.api.storage.composite.CompositeAwareChild

contains

Constructor Details

ExternalStorage

public ExternalStorage(ExternalStorageProvider provider,
 ExternalStorageListener listener)

Method Details

getProvider

public ExternalStorageProvider getProvider()

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

detectChanges

public boolean detectChanges()

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

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