Refactored StorageChannel enum into an interface (#3138)

This replaces the static enum with a more dynamic interface providing
factory methods for handling network storage.
This commit is contained in:
yueh
2017-10-08 17:59:30 +02:00
committed by GitHub
parent 8ad8ce68b5
commit 6e81f698c0
115 changed files with 1255 additions and 943 deletions
+10 -24
View File
@@ -25,14 +25,13 @@ package appeng.api;
import appeng.api.definitions.IDefinitions;
import appeng.api.exceptions.FailedConnection;
import appeng.api.features.IRegistryContainer;
import appeng.api.networking.IGridBlock;
import appeng.api.networking.IGridConnection;
import appeng.api.networking.IGridNode;
import appeng.api.networking.IGridHelper;
import appeng.api.parts.IPartHelper;
import appeng.api.storage.IStorageHelper;
@AEInjectable
public interface IAppEngApi
{
@@ -42,36 +41,23 @@ public interface IAppEngApi
IRegistryContainer registries();
/**
* @return helper for working with storage data types.
* @return A helper for working with storage data types.
*/
IStorageHelper storage();
/**
* @return helper for working with grids, and buses.
* @return A helper to create {@link IGridNode} and other grid related objects.
*/
IGridHelper grid();
/**
* @return A helper for working with grids, and buses.
*/
IPartHelper partHelper();
/**
* @return an accessible list of all AE definitions
* @return An accessible list of all AE definitions
*/
IDefinitions definitions();
/**
* create a grid node for your {@link appeng.api.networking.IGridHost}
*
* @param block grid block
*
* @return grid node of block
*/
IGridNode createGridNode( IGridBlock block );
/**
* create a connection between two {@link appeng.api.networking.IGridNode}
*
* @param a to be connected gridnode
* @param b to be connected gridnode
*
* @throws appeng.api.exceptions.FailedConnection
*/
IGridConnection createGridConnection( IGridNode a, IGridNode b ) throws FailedConnection;
}
@@ -0,0 +1,64 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2017 AlgorithmX2
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package appeng.api.networking;
import appeng.api.exceptions.FailedConnection;
/**
* A helper responsible for creating new {@link IGridNode}, {@link IGridConnection} or potentially similar tasks.
*
* @author yueh
* @version rv5
* @since rv5
*/
public interface IGridHelper
{
/**
* Create a grid node for your {@link IGridHost}
*
* The passed {@link IGridBlock} represents the definition for properties like connectable sides.
* Refer to its documentation for further details.
*
* @param block grid block
*
* @return grid node of block
*/
IGridNode createGridNode( IGridBlock block );
/**
* Create a direct connection between two {@link IGridNode}.
*
* This will be considered as having a distance of 1, regardless of the location of both nodes.
*
* @param a to be connected gridnode
* @param b to be connected gridnode
*
* @throws appeng.api.exceptions.FailedConnection
*/
IGridConnection createGridConnection( IGridNode a, IGridNode b ) throws FailedConnection;
}
@@ -25,7 +25,7 @@ package appeng.api.networking.events;
import appeng.api.storage.IMEMonitor;
import appeng.api.storage.StorageChannel;
import appeng.api.storage.IStorageChannel;
/**
@@ -40,9 +40,9 @@ public class MENetworkStorageEvent extends MENetworkEvent
{
public final IMEMonitor monitor;
public final StorageChannel channel;
public final IStorageChannel channel;
public MENetworkStorageEvent( final IMEMonitor o, final StorageChannel chan )
public MENetworkStorageEvent( final IMEMonitor o, final IStorageChannel chan )
{
this.monitor = o;
this.channel = chan;
@@ -25,7 +25,7 @@ package appeng.api.networking.storage;
import appeng.api.networking.security.IActionSource;
import appeng.api.storage.StorageChannel;
import appeng.api.storage.IStorageChannel;
import appeng.api.storage.data.IAEStack;
import appeng.api.storage.data.IItemList;
@@ -50,5 +50,5 @@ public interface IStackWatcherHost
* @param src action source
* @param chan storage channel
*/
void onStackChange( IItemList o, IAEStack fullStack, IAEStack diffStack, IActionSource src, StorageChannel chan );
void onStackChange( IItemList o, IAEStack fullStack, IAEStack diffStack, IActionSource src, IStorageChannel chan );
}
@@ -30,7 +30,7 @@ import appeng.api.networking.security.IActionSource;
import appeng.api.storage.ICellContainer;
import appeng.api.storage.ICellProvider;
import appeng.api.storage.IStorageMonitorable;
import appeng.api.storage.StorageChannel;
import appeng.api.storage.IStorageChannel;
import appeng.api.storage.data.IAEStack;
@@ -50,7 +50,7 @@ public interface IStorageGrid extends IGridCache, IStorageMonitorable
*
* @param input injected items
*/
void postAlterationOfStoredItems( StorageChannel chan, Iterable<? extends IAEStack> input, IActionSource src );
void postAlterationOfStoredItems( IStorageChannel chan, Iterable<? extends IAEStack> input, IActionSource src );
/**
* Used to add a cell provider to the storage system
@@ -28,6 +28,7 @@ import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.item.ItemStack;
import appeng.api.implementations.tiles.IChestOrDrive;
import appeng.api.storage.data.IAEStack;
/**
@@ -56,7 +57,7 @@ public interface ICellHandler
*
* @return a new IMEHandler for the provided item
*/
IMEInventoryHandler getCellInventory( ItemStack is, ISaveProvider host, StorageChannel channel );
<T extends IAEStack<T>> IMEInventoryHandler<T> getCellInventory( ItemStack is, ISaveProvider host, IStorageChannel<T> channel );
/**
* Called when the storage cell is planed in an ME Chest and the user tries to open the terminal side, if your item
@@ -70,7 +71,7 @@ public interface ICellHandler
* @param is item
* @param chan storage channel
*/
void openChestGui( EntityPlayer player, IChestOrDrive chest, ICellHandler cellHandler, IMEInventoryHandler inv, ItemStack is, StorageChannel chan );
<T extends IAEStack<T>> void openChestGui( EntityPlayer player, IChestOrDrive chest, ICellHandler cellHandler, IMEInventoryHandler<T> inv, ItemStack is, IStorageChannel<T> chan );
/**
* 0 - cell is missing.
@@ -86,10 +87,10 @@ public interface ICellHandler
*
* @return get the status of the cell based on its contents.
*/
int getStatusForCell( ItemStack is, IMEInventory handler );
<T extends IAEStack<T>> int getStatusForCell( ItemStack is, IMEInventory<T> handler );
/**
* @return the ae/t to drain for this storage cell inside a chest/drive.
*/
double cellIdleDrain( ItemStack is, IMEInventory handler );
<T extends IAEStack<T>> double cellIdleDrain( ItemStack is, IMEInventory<T> handler );
}
@@ -42,7 +42,7 @@ public interface ICellProvider
*
* @return a valid list of handlers, NEVER NULL
*/
List<IMEInventoryHandler> getCellArray( StorageChannel channel );
List<IMEInventoryHandler> getCellArray( IStorageChannel channel );
/**
* the storage's priority.
@@ -27,6 +27,7 @@ package appeng.api.storage;
import net.minecraft.item.ItemStack;
import appeng.api.IAppEngApi;
import appeng.api.storage.data.IAEStack;
/**
@@ -73,5 +74,5 @@ public interface ICellRegistry
*
* @return new IMEInventoryHandler, or null if there isn't one.
*/
IMEInventoryHandler getCellInventory( ItemStack is, ISaveProvider host, StorageChannel chan );
<T extends IAEStack<T>> IMEInventoryHandler<T> getCellInventory( ItemStack is, ISaveProvider host, IStorageChannel<T> chan );
}
@@ -40,7 +40,7 @@ import appeng.api.storage.data.IItemList;
* If you want to request a stack of an item, you should should determine that prior to requesting the stack from the
* inventory.
*/
public interface IMEInventory<StackType extends IAEStack>
public interface IMEInventory<T extends IAEStack<T>>
{
/**
@@ -52,7 +52,7 @@ public interface IMEInventory<StackType extends IAEStack>
*
* @return returns the number of items not added.
*/
StackType injectItems( StackType input, Actionable type, IActionSource src );
T injectItems( T input, Actionable type, IActionSource src );
/**
* Extract the specified item from the ME Inventory
@@ -62,7 +62,7 @@ public interface IMEInventory<StackType extends IAEStack>
*
* @return returns the number of items extracted, null
*/
StackType extractItems( StackType request, Actionable mode, IActionSource src );
T extractItems( T request, Actionable mode, IActionSource src );
/**
* request a full report of all available items, storage.
@@ -71,10 +71,10 @@ public interface IMEInventory<StackType extends IAEStack>
*
* @return returns same list that was passed in, is passed out
*/
IItemList<StackType> getAvailableItems( IItemList<StackType> out );
IItemList<T> getAvailableItems( IItemList<T> out );
/**
* @return the type of channel your handler should be part of
*/
StorageChannel getChannel();
IStorageChannel<T> getChannel();
}
@@ -32,9 +32,9 @@ import appeng.api.storage.data.IAEStack;
* Thin logic layer that can be swapped with different IMEInventory implementations, used to handle features related to
* storage, that are Separate from the storage medium itself.
*
* @param <StackType>
* @param <T>
*/
public interface IMEInventoryHandler<StackType extends IAEStack> extends IMEInventory<StackType>
public interface IMEInventoryHandler<T extends IAEStack<T>> extends IMEInventory<T>
{
/**
@@ -52,7 +52,7 @@ public interface IMEInventoryHandler<StackType extends IAEStack> extends IMEInve
*
* @return if its prioritized
*/
boolean isPrioritized( StackType input );
boolean isPrioritized( T input );
/**
* determine if an item can be accepted and stored.
@@ -61,7 +61,7 @@ public interface IMEInventoryHandler<StackType extends IAEStack> extends IMEInve
*
* @return if the item can be added
*/
boolean canAccept( StackType input );
boolean canAccept( T input );
/**
* determine what the priority of the inventory is.
@@ -29,7 +29,7 @@ import appeng.api.storage.data.IAEStack;
import appeng.api.storage.data.IItemList;
public interface IMEMonitor<T extends IAEStack> extends IMEInventoryHandler<T>, IBaseMonitor<T>
public interface IMEMonitor<T extends IAEStack<T>> extends IMEInventoryHandler<T>, IBaseMonitor<T>
{
/**
@@ -37,7 +37,7 @@ public interface IMEMonitor<T extends IAEStack> extends IMEInventoryHandler<T>,
*/
@Override
@Deprecated
IItemList<T> getAvailableItems( IItemList out );
IItemList<T> getAvailableItems( IItemList<T> out );
/**
* Get access to the full item list of the network, preferred over {@link IMEInventory} .getAvailableItems(...)
@@ -0,0 +1,103 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2013 AlgorithmX2
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package appeng.api.storage;
import java.io.IOException;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import io.netty.buffer.ByteBuf;
import net.minecraft.item.ItemStack;
import appeng.api.networking.energy.IEnergySource;
import appeng.api.networking.security.IActionSource;
import appeng.api.storage.data.IAEItemStack;
import appeng.api.storage.data.IAEStack;
import appeng.api.storage.data.IItemList;
public interface IStorageChannel<T extends IAEStack<T>>
{
/**
* Create a new {@link IItemList} of the specific type.
*
* @return
*/
@Nonnull
IItemList<T> createList();
/**
* Create a new {@link IAEStack} subtype of the specific object.
*
* The parameter is unbound to allow a slightly more flexible approach.
* But the general intention is about converting an {@link ItemStack} into the corresponding {@link IAEItemStack}.
* Another valid case might be to use it instead of {@link IAEStack#copy()}, but this might not be supported by all
* types.
*
* @param input The object to turn into an {@link IAEStack}
* @return The converted stack or null
*/
@Nullable
T createStack( @Nonnull Object input );
/**
*
* @param input
* @return
* @throws IOException
*/
@Nullable
T readFromPacket( @Nonnull ByteBuf input ) throws IOException;
/**
* use energy from energy, to remove request items from cell, at the request of src.
*
* @param energy to be drained energy source
* @param cell cell of requested items
* @param request requested items
* @param src action source
*
* @return items that successfully extracted.
*/
@Nullable
T poweredExtraction( @Nonnull IEnergySource energy, @Nonnull IMEInventory<T> cell, @Nonnull T request, @Nonnull IActionSource src );
/**
* use energy from energy, to inject input items into cell, at the request of src
*
* @param energy to be added energy source
* @param cell injected cell
* @param input to be injected items
* @param src action source
*
* @return items that failed to insert.
*/
@Nullable
T poweredInsert( @Nonnull IEnergySource energy, @Nonnull IMEInventory<T> cell, @Nonnull T input, @Nonnull IActionSource src );
}
@@ -24,26 +24,63 @@
package appeng.api.storage;
import java.io.IOException;
import java.util.Collection;
import io.netty.buffer.ByteBuf;
import javax.annotation.Nonnull;
import net.minecraft.item.ItemStack;
import net.minecraft.nbt.NBTTagCompound;
import net.minecraftforge.fluids.FluidStack;
import appeng.api.networking.crafting.ICraftingLink;
import appeng.api.networking.crafting.ICraftingRequester;
import appeng.api.networking.energy.IEnergySource;
import appeng.api.networking.security.IActionSource;
import appeng.api.storage.data.IAEFluidStack;
import appeng.api.storage.data.IAEItemStack;
import appeng.api.storage.data.IItemList;
import appeng.api.storage.data.IAEStack;
public interface IStorageHelper
{
/**
* Register a new storage channel.
*
* AE2 already provides native channels for {@link IAEItemStack} and {@link IAEFluidStack}.
*
* Each {@link IAEStack} subtype can only have a single factory instance. Overwriting is not intended.
* Each subtype should be a direct one, this might be enforced at any time.
*
* Channel class and factory instance can be used interchangeable as identifier. In most cases the factory instance
* is used as key as having direct access the methods is more beneficial compared to being forced to query the
* registry each time.
*
* Caching the factory instance in a field or local variable is perfectly for performance reasons. But do not use
* any AE2 internal field as they can change randomly between releases.
*
* @param channel The channel type, must be a subtype of {@link IStorageChannel}
* @param factory An instance implementing the channel, must be be an instance of channel
*/
@Nonnull
<T extends IAEStack<T>, C extends IStorageChannel<T>> void registerStorageChannel( @Nonnull Class<C> channel, @Nonnull C factory );
/**
* Fetch the factory instance for a specific storage channel.
*
* Channel must be a direct subtype of {@link IStorageChannel}.
*
* @throws NullPointerException when fetching an unregistered channel.
* @param channel The channel type
* @return the factory instance
*/
@Nonnull
<T extends IAEStack<T>, C extends IStorageChannel<T>> C getStorageChannel( @Nonnull Class<C> channel );
/**
* An unmodifiable collection of all registered factory instance.
*
* This is mainly used as helper to let storage grids construct their internal storage for each type.
*/
@Nonnull
Collection<IStorageChannel<? extends IAEStack<?>>> storageChannels();
/**
* load a crafting link from nbt data.
*
@@ -53,73 +90,4 @@ public interface IStorageHelper
*/
ICraftingLink loadCraftingLink( NBTTagCompound data, ICraftingRequester req );
/**
* @param is An ItemStack
*
* @return a new INSTANCE of {@link IAEItemStack} from a MC {@link ItemStack}
*/
IAEItemStack createItemStack( ItemStack is );
/**
* @param is A FluidStack
*
* @return a new INSTANCE of {@link IAEFluidStack} from a Forge {@link FluidStack}
*/
IAEFluidStack createFluidStack( FluidStack is );
/**
* @return a new INSTANCE of {@link IItemList} for items
*/
IItemList<IAEItemStack> createItemList();
/**
* @return a new INSTANCE of {@link IItemList} for fluids
*/
IItemList<IAEFluidStack> createFluidList();
/**
* Read a AE Item Stack from a byte stream, returns a AE item stack or null.
*
* @param input to be loaded data
*
* @return item based of data
*
* @throws IOException if file could not be read
*/
IAEItemStack readItemFromPacket( ByteBuf input ) throws IOException;
/**
* Read a AE Fluid Stack from a byte stream, returns a AE fluid stack or null.
*
* @param input to be loaded data
*
* @return fluid based on data
*
* @throws IOException if file could not be written
*/
IAEFluidStack readFluidFromPacket( ByteBuf input ) throws IOException;
/**
* use energy from energy, to remove request items from cell, at the request of src.
*
* @param energy to be drained energy source
* @param cell cell of requested items
* @param request requested items
* @param src action source
*
* @return items that successfully extracted.
*/
IAEItemStack poweredExtraction( IEnergySource energy, IMEInventory<IAEItemStack> cell, IAEItemStack request, IActionSource src );
/**
* use energy from energy, to inject input items into cell, at the request of src
*
* @param energy to be added energy source
* @param cell injected cell
* @param input to be injected items
* @param src action source
*
* @return items that failed to insert.
*/
IAEItemStack poweredInsert( IEnergySource energy, IMEInventory<IAEItemStack> cell, IAEItemStack input, IActionSource src );
}
@@ -24,8 +24,7 @@
package appeng.api.storage;
import appeng.api.storage.data.IAEFluidStack;
import appeng.api.storage.data.IAEItemStack;
import appeng.api.storage.data.IAEStack;
/**
@@ -35,13 +34,6 @@ import appeng.api.storage.data.IAEItemStack;
public interface IStorageMonitorable
{
/**
* Access the item inventory for the monitorable storage.
*/
IMEMonitor<IAEItemStack> getItemInventory();
<T extends IAEStack<T>> IMEMonitor<T> getInventory( IStorageChannel<T> channel );
/**
* Access the fluid inventory for the monitorable storage.
*/
IMEMonitor<IAEFluidStack> getFluidInventory();
}
@@ -41,47 +41,47 @@ import appeng.api.storage.data.IItemList;
* Common implementation of a simple class that monitors injection/extraction of a inventory to send events to a list of
* listeners.
*
* @param <StackType>
* @param <T>
* @deprecated
*
* TODO: Needs to be redesigned to solve performance issues. Also should not be part of the API as class.
*/
@Deprecated
public class MEMonitorHandler<StackType extends IAEStack> implements IMEMonitor<StackType>
public class MEMonitorHandler<T extends IAEStack<T>> implements IMEMonitor<T>
{
private final IMEInventoryHandler<StackType> internalHandler;
private final IItemList<StackType> cachedList;
private final HashMap<IMEMonitorHandlerReceiver<StackType>, Object> listeners = new HashMap<>();
private final IMEInventoryHandler<T> internalHandler;
private final IItemList<T> cachedList;
private final HashMap<IMEMonitorHandlerReceiver<T>, Object> listeners = new HashMap<>();
protected boolean hasChanged = true;
public MEMonitorHandler( final IMEInventoryHandler<StackType> t )
public MEMonitorHandler( final IMEInventoryHandler<T> t )
{
this.internalHandler = t;
this.cachedList = t.getChannel().createList();
}
public MEMonitorHandler( final IMEInventoryHandler<StackType> t, final StorageChannel chan )
public MEMonitorHandler( final IMEInventoryHandler<T> t, final IStorageChannel<T> chan )
{
this.internalHandler = t;
this.cachedList = chan.createList();
}
@Override
public void addListener( final IMEMonitorHandlerReceiver<StackType> l, final Object verificationToken )
public void addListener( final IMEMonitorHandlerReceiver<T> l, final Object verificationToken )
{
this.listeners.put( l, verificationToken );
}
@Override
public void removeListener( final IMEMonitorHandlerReceiver<StackType> l )
public void removeListener( final IMEMonitorHandlerReceiver<T> l )
{
this.listeners.remove( l );
}
@Override
public StackType injectItems( final StackType input, final Actionable mode, final IActionSource src )
public T injectItems( final T input, final Actionable mode, final IActionSource src )
{
if( mode == Actionable.SIMULATE )
{
@@ -90,14 +90,14 @@ public class MEMonitorHandler<StackType extends IAEStack> implements IMEMonitor<
return this.monitorDifference( input.copy(), this.getHandler().injectItems( input, mode, src ), false, src );
}
protected IMEInventoryHandler<StackType> getHandler()
protected IMEInventoryHandler<T> getHandler()
{
return this.internalHandler;
}
private StackType monitorDifference( final IAEStack original, final StackType leftOvers, final boolean extraction, final IActionSource src )
private T monitorDifference( final T original, final T leftOvers, final boolean extraction, final IActionSource src )
{
final StackType diff = (StackType) original.copy();
final T diff = original.copy();
if( extraction )
{
@@ -116,19 +116,19 @@ public class MEMonitorHandler<StackType extends IAEStack> implements IMEMonitor<
return leftOvers;
}
protected void postChangesToListeners( final Iterable<StackType> changes, final IActionSource src )
protected void postChangesToListeners( final Iterable<T> changes, final IActionSource src )
{
this.notifyListenersOfChange( changes, src );
}
protected void notifyListenersOfChange( final Iterable<StackType> diff, final IActionSource src )
protected void notifyListenersOfChange( final Iterable<T> diff, final IActionSource src )
{
this.hasChanged = true;// need to update the cache.
final Iterator<Entry<IMEMonitorHandlerReceiver<StackType>, Object>> i = this.getListeners();
final Iterator<Entry<IMEMonitorHandlerReceiver<T>, Object>> i = this.getListeners();
while( i.hasNext() )
{
final Entry<IMEMonitorHandlerReceiver<StackType>, Object> o = i.next();
final IMEMonitorHandlerReceiver<StackType> receiver = o.getKey();
final Entry<IMEMonitorHandlerReceiver<T>, Object> o = i.next();
final IMEMonitorHandlerReceiver<T> receiver = o.getKey();
if( receiver.isValid( o.getValue() ) )
{
receiver.postChange( this, diff, src );
@@ -140,13 +140,13 @@ public class MEMonitorHandler<StackType extends IAEStack> implements IMEMonitor<
}
}
protected Iterator<Entry<IMEMonitorHandlerReceiver<StackType>, Object>> getListeners()
protected Iterator<Entry<IMEMonitorHandlerReceiver<T>, Object>> getListeners()
{
return this.listeners.entrySet().iterator();
}
@Override
public StackType extractItems( final StackType request, final Actionable mode, final IActionSource src )
public T extractItems( final T request, final Actionable mode, final IActionSource src )
{
if( mode == Actionable.SIMULATE )
{
@@ -156,7 +156,7 @@ public class MEMonitorHandler<StackType extends IAEStack> implements IMEMonitor<
}
@Override
public StorageChannel getChannel()
public IStorageChannel<T> getChannel()
{
return this.getHandler().getChannel();
}
@@ -168,7 +168,7 @@ public class MEMonitorHandler<StackType extends IAEStack> implements IMEMonitor<
}
@Override
public IItemList<StackType> getStorageList()
public IItemList<T> getStorageList()
{
if( this.hasChanged )
{
@@ -181,19 +181,19 @@ public class MEMonitorHandler<StackType extends IAEStack> implements IMEMonitor<
}
@Override
public boolean isPrioritized( final StackType input )
public boolean isPrioritized( final T input )
{
return this.getHandler().isPrioritized( input );
}
@Override
public boolean canAccept( final StackType input )
public boolean canAccept( final T input )
{
return this.getHandler().canAccept( input );
}
@Override
public IItemList<StackType> getAvailableItems( final IItemList out )
public IItemList<T> getAvailableItems( final IItemList<T> out )
{
return this.getHandler().getAvailableItems( out );
}
@@ -1,7 +1,7 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2013 AlgorithmX2
* Copyright (c) 2017 AlgorithmX2
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
@@ -21,44 +21,14 @@
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package appeng.api.storage;
package appeng.api.storage.channels;
import appeng.api.AEApi;
import appeng.api.storage.IStorageChannel;
import appeng.api.storage.data.IAEFluidStack;
import appeng.api.storage.data.IAEItemStack;
import appeng.api.storage.data.IAEStack;
import appeng.api.storage.data.IItemList;
public enum StorageChannel
public interface IFluidStorageChannel extends IStorageChannel<IAEFluidStack>
{
/**
* AE2's Default Storage.
*/
ITEMS( IAEItemStack.class ),
/**
* AE2's Fluid Based Storage ( mainly added to better support ExtraCells )
*/
FLUIDS( IAEFluidStack.class );
public final Class<? extends IAEStack> type;
StorageChannel( final Class<? extends IAEStack> t )
{
this.type = t;
}
public IItemList createList()
{
if( this == ITEMS )
{
return AEApi.instance().storage().createItemList();
}
else
{
return AEApi.instance().storage().createFluidList();
}
}
}
@@ -0,0 +1,34 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2017 AlgorithmX2
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package appeng.api.storage.channels;
import appeng.api.storage.IStorageChannel;
import appeng.api.storage.data.IAEItemStack;
public interface IItemStorageChannel extends IStorageChannel<IAEItemStack>
{
}
@@ -37,7 +37,7 @@ import net.minecraftforge.fluids.FluidStack;
*
* Don't Implement.
*
* Construct with Util.createFluidStack( FluidStack )
* Construct with AEApi.instance().storage().getStorageChannel( IFluidStorageChannel.class).createStack( FluidStack )
*/
public interface IAEFluidStack extends IAEStack<IAEFluidStack>
{
@@ -36,7 +36,7 @@ import net.minecraft.item.ItemStack;
*
* Don't Implement.
*
* Construct with Util.createItemStack( ItemStack )
* Construct with AEApi.instance().storage().getStorageChannel( IItemStorageChannel.class).createStack( ItemStack )
*/
public interface IAEItemStack extends IAEStack<IAEItemStack>
{
@@ -32,7 +32,7 @@ import net.minecraft.item.ItemStack;
import net.minecraft.nbt.NBTTagCompound;
import appeng.api.config.FuzzyMode;
import appeng.api.storage.StorageChannel;
import appeng.api.storage.IStorageChannel;
public interface IAEStack<StackType extends IAEStack<StackType>>
@@ -196,7 +196,7 @@ public interface IAEStack<StackType extends IAEStack<StackType>>
/**
* @return ITEM or FLUID
*/
StorageChannel getChannel();
IStorageChannel getChannel();
/**
* Returns itemstack for display and similar purposes. Always has a count of 1.
@@ -34,9 +34,8 @@ import appeng.api.config.FuzzyMode;
*
* Don't Implement.
*
* Construct with Util.createItemList()
*/
public interface IItemContainer<StackType extends IAEStack>
public interface IItemContainer<T extends IAEStack<T>>
{
/**
@@ -44,7 +43,7 @@ public interface IItemContainer<StackType extends IAEStack>
*
* @param option added stack
*/
void add( StackType option ); // adds stack as is
void add( T option ); // adds stack as is
/**
* @param i compared item
@@ -52,14 +51,14 @@ public interface IItemContainer<StackType extends IAEStack>
* @return a stack equivalent to the stack passed in, but with the correct stack size information, or null if its
* not present
*/
StackType findPrecise( StackType i );
T findPrecise( T i );
/**
* @param input compared item
*
* @return a list of relevant fuzzy matched stacks
*/
Collection<StackType> findFuzzy( StackType input, FuzzyMode fuzzy );
Collection<T> findFuzzy( T input, FuzzyMode fuzzy );
/**
* @return true if there are no items in the list
@@ -26,15 +26,20 @@ package appeng.api.storage.data;
import java.util.Iterator;
import appeng.api.storage.IStorageChannel;
/**
* Represents a list of items in AE.
*
* Don't Implement.
*
* Construct with Util.createItemList()
* Construct with
* - For items: AEApi.instance().storage().getStorageChannel( IItemStorageChannel.class).createList()
* - For fluids: AEApi.instance().storage().getStorageChannel( IFluidStorageChannel.class).createList()
* - Replace with the corresponding {@link IStorageChannel} type for non native channels
*/
public interface IItemList<StackType extends IAEStack> extends IItemContainer<StackType>, Iterable<StackType>
public interface IItemList<T extends IAEStack<T>> extends IItemContainer<T>, Iterable<T>
{
/**
@@ -43,14 +48,14 @@ public interface IItemList<StackType extends IAEStack> extends IItemContainer<St
*
* @param option stacktype option
*/
void addStorage( StackType option ); // adds a stack as stored
void addStorage( T option ); // adds a stack as stored
/**
* add a stack to the list as craftable, this will merge the stack with an item already in the list if found.
*
* @param option stacktype option
*/
void addCrafting( StackType option );
void addCrafting( T option );
/**
* add a stack to the list, stack size is used to add to requestable, this will merge the stack with an item already
@@ -58,12 +63,12 @@ public interface IItemList<StackType extends IAEStack> extends IItemContainer<St
*
* @param option stacktype option
*/
void addRequestable( StackType option ); // adds a stack as requestable
void addRequestable( T option ); // adds a stack as requestable
/**
* @return the first item in the list
*/
StackType getFirstItem();
T getFirstItem();
/**
* @return the number of items in the list
@@ -74,7 +79,7 @@ public interface IItemList<StackType extends IAEStack> extends IItemContainer<St
* allows you to iterate the list.
*/
@Override
Iterator<StackType> iterator();
Iterator<T> iterator();
/**
* resets stack sizes to 0.