src/main/java/mekanism/api/gas/GasStack.java

package mekanism.api.gas;

import net.minecraft.nbt.NBTTagCompound;

/**
 * GasStack - a specified amount of a defined Gas with certain properties.
 * @author aidancbrady
 *
 */
public class GasStack
{
	private Gas type;

	public int amount;

	/**
	 * Creates a new GasStack with a defined gas ID and quantity.
	 * @param id - gas ID to associate this GasStack to, will perform a GasRegistry lookup in the constructor
	 * @param quantity - amount of gas to be referenced in this GasStack
	 */
	public GasStack(int id, int quantity)
	{
		type = GasRegistry.getGas(id);
		amount = quantity;
	}

	/**
	 * Creates a new GasStack with a defined Gas type and quantity.
	 * @param gas - gas type of the stack
	 * @param quantity - amount of gas to be referenced in this GasStack
	 */
	public GasStack(Gas gas, int quantity)
	{
		type = gas;
		amount = quantity;
	}

	private GasStack() {}

	/**
	 * Gets the Gas type of this GasStack.
	 * @return this GasStack's Gas type
	 */
	public Gas getGas()
	{
		return type;
	}

	/**
	 * Writes this GasStack to a defined tag compound.
	 * @param nbtTags - tag compound to write to
	 * @return tag compound with this GasStack's data
	 */
	public NBTTagCompound write(NBTTagCompound nbtTags)
	{
		type.write(nbtTags);
		nbtTags.setInteger("amount", amount);

		return nbtTags;
	}

	/**
	 * Reads this GasStack's data from a defined tag compound.
	 * @param nbtTags - tag compound to read from
	 */
	public void read(NBTTagCompound nbtTags)
	{
		type = Gas.readFromNBT(nbtTags);
		amount = nbtTags.getInteger("amount");
	}

	/**
	 * Returns the GasStack stored in the defined tag compound, or null if it doesn't exist.
	 * @param nbtTags - tag compound to read from
	 * @return GasStack stored in the tag compound
	 */
	public static GasStack readFromNBT(NBTTagCompound nbtTags)
	{
		if(nbtTags == null || nbtTags.hasNoTags())
		{
			return null;
		}

		GasStack stack = new GasStack();
		stack.read(nbtTags);

		if(stack.getGas() == null)
		{
			return null;
		}

		return stack;
	}

	/**
	 * Returns a copied form of this GasStack.
	 * @return copied GasStack
	 */
	public GasStack copy()
	{
		return new GasStack(type, amount);
	}

	/**
	 * Whether or not this GasStack's gas type is equal to the other defined GasStack.
	 * @param stack - GasStack to check
	 * @return if the GasStacks contain the same gas type
	 */
	public boolean isGasEqual(GasStack stack)
	{
		return stack != null && getGas() == stack.getGas();
	}

	@Override
	public String toString()
	{
		return "[" + type + ", " + amount + "]";
	}
}