Merge branch 'sprint4_master' into story36_boundary_fix_attempt_2

network/src/main/java/seng302/Networking/Messages/XMLMessage.java

@@ -20,6 +20,15 @@ public class XMLMessage extends AC35Data {
     public static int XMLTypeRace = 6;
     public static int XMLTypeBoat = 7;
 
+    /**
+     * Constructor for an XML Message
+     * @param ackNumber Number for acknowledgement inherited for the AC35Data Packet
+     * @param timeStamp Time received
+     * @param xmlMsgSubType Type of XML message
+     * @param sequenceNumber Order that it has arrived in
+     * @param xmlMsgLength Length of the xml message
+     * @param xmlMessage XML message
+     */
     public XMLMessage(int ackNumber, long timeStamp, int xmlMsgSubType, int sequenceNumber, int xmlMsgLength, InputStream xmlMessage){
         super(MessageType.XMLMESSAGE);
         this.ackNumber = ackNumber;
@@ -30,10 +39,18 @@ public class XMLMessage extends AC35Data {
         this.xmlMessage = xmlMessage;
     }
 
+    /**
+     * Get the XML Message
+     * @return the XML message as an input stream
+     */
     public InputStream getXmlMessage() {
         return xmlMessage;
     }
 
+    /**
+     * Get the type of message
+     * @return Gets the type of message the XML message is
+     */
     public int getXmlMsgSubType() {
         return xmlMsgSubType;
     }