[Update] Version 0.5.1

More documentation, and an updated list of packets

11 files changed, 304 insertions, 29 deletions

diff --git a/src/main/java/net/transit/network/packet/IStaticPacket.java b/src/main/java/net/transit/network/packet/IStaticPacket.java
new file mode 100644
index 0000000..01073d3
--- /dev/null
+++ b/src/main/java/net/transit/network/packet/IStaticPacket.java
@@ -0,0 +1,23 @@
+package net.transit.network.packet;
+
+import net.transit.type.Type;
+
+/** Interface describing an unchanging packet.
+ * @author Kyle Gunger
+ *
+ * @param <D> The data type (Object) that the packet transfers.
+ */
+public interface IStaticPacket<D>
+{
+	/**Get the packet's data.
+	 * 
+	 * @return <D> The packet's data
+	 */
+    public D getData();
+    
+    /**Get the packet's type.
+     * 
+     * @return IType<<D>> The type of the packet
+     */
+    public Type<D> getType();
+}
\ No newline at end of file
diff --git a/src/main/java/net/transit/network/packet/MetaPacket.java b/src/main/java/net/transit/network/packet/MetaPacket.java
index 0240519..7e49318 100644
--- a/src/main/java/net/transit/network/packet/MetaPacket.java
+++ b/src/main/java/net/transit/network/packet/MetaPacket.java
@@ -2,32 +2,34 @@ package net.transit.network.packet;
 
 import net.transit.type.Type;
 
-public class MetaPacket<D, M> implements Packet<D>
+/** Static packet with extra data attached.
+ * @author Kyle Gunger
+ *
+ * @param <D> The data type (Object) that the packet transfers
+ * @param <M> The type of metadata
+*/
+public class MetaPacket<D, M> extends StaticPacket<D>
 {
-	
-	private D data;
 	private M metaData;
-	private Type<D> type;
 
+    /** Constructor
+     * 
+     * @param dat The data to store
+     * @param t The Type of the data
+     * @param meta The metadata to store
+     */
     public MetaPacket(D dat, Type<D> t, M meta)
     {
-        data = dat;
-        type = t;
+        super(dat, t);
         metaData = meta;
     }
-
-    public D getData()
-    {
-        return data;
-    }
     
+    /** Get the metadata of the packet.
+     * 
+     * @return The packet's metadata
+     */
     public M getMetaData()
     {
     	return metaData;
     }
-    
-    @Override
-	public Type<D> getType() {
-		return type;
-	}
 }
diff --git a/src/main/java/net/transit/network/packet/StaticPacket.java b/src/main/java/net/transit/network/packet/StaticPacket.java
index b14e442..eeeae3f 100644
--- a/src/main/java/net/transit/network/packet/StaticPacket.java
+++ b/src/main/java/net/transit/network/packet/StaticPacket.java
@@ -2,17 +2,28 @@ package net.transit.network.packet;
 
 import net.transit.type.Type;
 
-public class StaticPacket<D> implements Packet<D>
+/** Simple packet which stores an unchanging value.
+ * @author Kyle Gunger
+ *
+ * @param <D> The data type (Object) that the packet transfers.
+ */
+public class StaticPacket<D> implements IStaticPacket<D>
 {
     private D data;
     private Type<D> type;
 
+    /** Constructor. Stores the given data and uses the given type.
+     * 
+     * @param dat The packet's data
+     * @param t The packet's type
+     */
     public StaticPacket(D dat, Type<D> t)
     {
         data = dat;
         type = t;
     }
 
+    @Override
     public D getData()
     {
         return data;
diff --git a/src/main/java/net/transit/network/packet/dynamic/ArrayPacket.java b/src/main/java/net/transit/network/packet/dynamic/ArrayPacket.java
new file mode 100644
index 0000000..0c27c80
--- /dev/null
+++ b/src/main/java/net/transit/network/packet/dynamic/ArrayPacket.java
@@ -0,0 +1,74 @@
+package net.transit.network.packet.dynamic;
+
+import java.util.ArrayList;
+
+import net.transit.type.Type;
+
+/** A packet type which stores multiple values which can be accessed.  When getting data, pop and shift from the array.
+ * @author Kyle Gunger
+ *
+ * @param <D> The data type (Object) that the packet transfers
+ */
+public class ArrayPacket<D> implements IDynamicPacket<D>
+{
+    private ArrayList<D> arrayData;
+    private Type<D> type;
+
+    /** Constructor
+     * Create an array packet.  Adds the starting value.
+     * @param startValue The starting value
+     * @param t The type of the packet
+    */
+    public ArrayPacket(D startValue, Type<D> t)
+    {
+        arrayData = new ArrayList<D>(0);
+        arrayData.add(startValue);
+        type = t;
+    }
+
+    /**
+     * Create an empty array packet of the desired type.
+     * @param t The type of the packet
+    */
+    public ArrayPacket(Type<D> t)
+    {
+        arrayData = new ArrayList<D>(0);
+        type = t;
+    }
+    
+    /** Pop and shift data from the array.
+     */
+    @Override
+    public D getData()
+    {
+        D temp = null;
+        
+        if(arrayData.size() > 0)
+        {
+            temp = arrayData.remove(0);
+        }
+
+        return temp;
+    }
+
+    /** Add data to the array.
+     * @param data The data to push
+     */
+    public void setData(D data)
+    {
+        arrayData.add(data);
+    }
+    
+    /** 
+     * @return The ammount of data the packet holds
+     */
+    public int dataStored()
+    {
+    	return arrayData.size();
+    }
+    
+    @Override
+	public Type<D> getType() {
+		return type;
+	}
+}
\ No newline at end of file
diff --git a/src/main/java/net/transit/network/packet/dynamic/DynamicPacket.java b/src/main/java/net/transit/network/packet/dynamic/DynamicPacket.java
new file mode 100644
index 0000000..0860487
--- /dev/null
+++ b/src/main/java/net/transit/network/packet/dynamic/DynamicPacket.java
@@ -0,0 +1,43 @@
+package net.transit.network.packet.dynamic;
+
+import net.transit.type.Type;
+
+/**
+ * Simple packet which stores a fluid value.
+ * 
+ * @author Kyle Gunger
+ *
+ * @param <D> The data type (Object) that the packet transfers
+ */
+public class DynamicPacket<D> implements IDynamicPacket<D> {
+    private D data;
+    private Type<D> type;
+
+    /** Constructor. Stores the given data and uses the given type.
+     * 
+     * @param dat The packet's data
+     * @param t The packet's type
+     */
+    public DynamicPacket(D dat, Type<D> t)
+    {
+        data = dat;
+        type = t;
+    }
+
+    @Override
+    public D getData()
+    {
+        return data;
+    }
+
+    @Override
+    public void setData(D dat)
+    {
+        data = dat;
+    }
+
+	@Override
+	public Type<D> getType() {
+		return type;
+	}
+}
\ No newline at end of file
diff --git a/src/main/java/net/transit/network/packet/dynamic/IDynamicPacket.java b/src/main/java/net/transit/network/packet/dynamic/IDynamicPacket.java
new file mode 100644
index 0000000..51b3c13
--- /dev/null
+++ b/src/main/java/net/transit/network/packet/dynamic/IDynamicPacket.java
@@ -0,0 +1,16 @@
+package net.transit.network.packet.dynamic;
+
+import net.transit.network.packet.IStaticPacket;
+
+/** Interface describing a fluid packet.
+ * @author Kyle Gunger
+ *
+ * @param <D> The data type (Object) that the packet transfers
+ */
+public interface IDynamicPacket<D> extends IStaticPacket<D>{
+    /**Set the packet's data.
+	 * 
+	 * @return <D> The packet's data
+	 */
+    public void setData(D dat);
+}
\ No newline at end of file
diff --git a/src/main/java/net/transit/network/packet/dynamic/MetaDynamicPacket.java b/src/main/java/net/transit/network/packet/dynamic/MetaDynamicPacket.java
new file mode 100644
index 0000000..b6a3ec6
--- /dev/null
+++ b/src/main/java/net/transit/network/packet/dynamic/MetaDynamicPacket.java
@@ -0,0 +1,44 @@
+package net.transit.network.packet.dynamic;
+
+import net.transit.type.Type;
+
+/** Static packet with extra data attached.
+ * @author Kyle Gunger
+ *
+ * @param <D> The data type (Object) that the packet transfers
+ * @param <M> The type of metadata
+*/
+public class MetaDynamicPacket<D, M> extends DynamicPacket<D>
+{
+	private M metaData;
+
+    /** Constructor
+     * 
+     * @param dat The data to store
+     * @param t The Type of the data
+     * @param meta The metadata to store
+     */
+    public MetaDynamicPacket(D dat, Type<D> t, M meta)
+    {
+        super(dat, t);
+        metaData = meta;
+    }
+    
+    /** Get the metadata of the packet.
+     * 
+     * @return The packet's metadata
+     */
+    public M getMetaData()
+    {
+    	return metaData;
+    }
+
+    /** Set the metadata of the packet.
+     * 
+     * @param meta The packet's new metadata
+     */
+    public void setMetaData(M meta)
+    {
+        metaData = meta;
+    }
+}
diff --git a/src/main/java/net/transit/network/system/INode.java b/src/main/java/net/transit/network/system/INode.java
new file mode 100644
index 0000000..9c42bf1
--- /dev/null
+++ b/src/main/java/net/transit/network/system/INode.java
@@ -0,0 +1,45 @@
+package net.transit.network.system;
+
+/**
+ * @author Kyle Gunger
+ * @apiNote A node inside or outside a system. Provides acceptors and providers to other nodes.
+ */
+public interface INode
+{
+	
+	/**Returns the groupIDs of groups the node interacts with
+	 * 
+	 * @return String[]
+	 */
+	public String[] groupsProvided();
+	
+	
+	/**Get the system managing the node or {@code null} if there isn't one
+	 * 
+	 * @return System
+	 */
+	public System getSystem();
+	
+	
+	/** Get the data of one of the TypeGroups the Node supports
+	 * 
+	 * @param groupID
+	 * @return
+	 */
+	public Object getData(String groupID);
+	
+	
+	/** Set the group data for the node
+	 * 
+	 * @param dat
+	 * @param groupID
+	 */
+	public void setData(Object dat, String groupID);
+	
+	
+	/** Get the nodes that this node is connected to
+	 * 
+	 * @return Node[]
+	 */
+	public INode[] getConnections();
+}
diff --git a/src/main/java/net/transit/network/system/ISystem.java b/src/main/java/net/transit/network/system/ISystem.java
new file mode 100644
index 0000000..fd2fa51
--- /dev/null
+++ b/src/main/java/net/transit/network/system/ISystem.java
@@ -0,0 +1,17 @@
+package net.transit.network.system;
+
+
+/**ISystem - a group of nodes optimized for performance
+ * 
+ * A node can exist without a system, but a system can not exist without at least one root node.
+ * 
+ * @param T The object type stored in the system.
+ */
+public interface ISystem
+{
+	/**The nodes stored by the system
+	 * 
+	 * @return INode[]
+	 */
+	public INode[] getNodes();
+}
diff --git a/src/main/java/net/transit/network/system/swap/AcceptorNode.java b/src/main/java/net/transit/network/system/swap/AcceptorNode.java
index 2dfd7a5..14c672d 100644
--- a/src/main/java/net/transit/network/system/swap/AcceptorNode.java
+++ b/src/main/java/net/transit/network/system/swap/AcceptorNode.java
@@ -1,9 +1,9 @@
 package net.transit.network.system.swap;
 
-import net.transit.network.packet.Packet;
-import net.transit.network.system.Node;
+import net.transit.network.packet.IStaticPacket;
+import net.transit.network.system.INode;
 
-public interface AcceptorNode extends Node
+public interface AcceptorNode extends INode
 {
 	
 	/** Link another node as a provider
@@ -12,7 +12,7 @@ public interface AcceptorNode extends Node
 	 * @param group
 	 * @return
 	 */
-	public boolean linkProvider(Node requester, String group);
+	public boolean linkProvider(INode requester, String group);
 	
 	
 	/** Unlink a provider from the acceptor
@@ -20,13 +20,13 @@ public interface AcceptorNode extends Node
 	 * @param toUnlink
 	 * @return
 	 */
-	public boolean unlinkProvider(Node toUnlink);
+	public boolean unlinkProvider(INode toUnlink);
 	
 	
 	/**
 	 * @return Node[]
 	 */
-	public Node[] getProviders();
+	public INode[] getProviders();
 	
 	
 	/** Accept a packet from a provider
@@ -35,5 +35,5 @@ public interface AcceptorNode extends Node
 	 * @param group
 	 * @return
 	 */
-	public boolean accept(Packet<?> packet, String group);
+	public boolean accept(IStaticPacket<?> packet, String group);
 }
diff --git a/src/main/java/net/transit/network/system/swap/ProviderNode.java b/src/main/java/net/transit/network/system/swap/ProviderNode.java
index 1ba1ef3..831c87f 100644
--- a/src/main/java/net/transit/network/system/swap/ProviderNode.java
+++ b/src/main/java/net/transit/network/system/swap/ProviderNode.java
@@ -1,8 +1,8 @@
 package net.transit.network.system.swap;
 
-import net.transit.network.system.Node;
+import net.transit.network.system.INode;
 
-public interface ProviderNode extends Node{
+public interface ProviderNode extends INode{
 	
 	/** Link another node as an acceptor
 	 * 
@@ -10,7 +10,7 @@ public interface ProviderNode extends Node{
 	 * @param group
 	 * @return boolean
 	 */
-	public boolean linkAcceptor(Node requester, String group);
+	public boolean linkAcceptor(INode requester, String group);
 	
 	
 	/** Unlink a provider from the acceptor
@@ -18,12 +18,12 @@ public interface ProviderNode extends Node{
 	 * @param toUnlink
 	 * @return
 	 */
-	public boolean unlinkAcceptor(Node toUnlink);
+	public boolean unlinkAcceptor(INode toUnlink);
 	
 	
 	/**
 	 * @return Node[]
 	 */
-	public Node[] getAcceptors();
+	public INode[] getAcceptors();
 	
 }