[Arianne-commits] marauroa/src/marauroa/common/net OutputSerializer.java, 1.8, 1.9 Serializable.java, 1.4, 1.5

[Hendrik <nh...@us...>]

Update of /cvsroot/arianne/marauroa/src/marauroa/common/net
In directory sc8-pr-cvs11.sourceforge.net:/tmp/cvs-serv26875/src/marauroa/common/net

Modified Files:
	OutputSerializer.java Serializable.java 
Log Message:
added JavaDoc

Index: OutputSerializer.java
===================================================================
RCS file: /cvsroot/arianne/marauroa/src/marauroa/common/net/OutputSerializer.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** OutputSerializer.java	10 Oct 2007 18:23:29 -0000	1.8
--- OutputSerializer.java	4 Nov 2007 20:47:28 -0000	1.9
***************
*** 24,28 ****
  public class OutputSerializer {
  
! 	OutputStream out;
  
  	/**
--- 24,28 ----
  public class OutputSerializer {
  
! 	private OutputStream out;
  
  	/**
***************
*** 42,45 ****
--- 42,47 ----
  	 * @param obj
  	 *            the object to serialize
+ 	 * @throws IOException
+ 	 *            in case of an IO-error
  	 */
  	public void write(marauroa.common.net.Serializable obj) throws IOException {
***************
*** 52,55 ****
--- 54,59 ----
  	 * @param a
  	 *            the byte to serialize
+ 	 * @throws IOException
+ 	 *            in case of an IO-error
  	 */
  	public void write(byte a) throws IOException {
***************
*** 62,65 ****
--- 66,71 ----
  	 * @param a
  	 *            the byte array to serialize
+ 	 * @throws IOException
+ 	 *            in case of an IO-error
  	 */
  	public void write(byte[] a) throws IOException {
***************
*** 73,76 ****
--- 79,84 ----
  	 * @param a
  	 *            the byte array to serialize
+ 	 * @throws IOException
+ 	 *            in case of an IO-error
  	 */
  	public void write255LongArray(byte[] a) throws IOException {
***************
*** 83,86 ****
--- 91,102 ----
  	}
  
+ 	/**
+ 	 * Add a long byte array whose size is smaller than 2^31 to the serializer
+ 	 *
+ 	 * @param a
+ 	 *            the byte array to serialize
+ 	 * @throws IOException
+ 	 *            in case of an IO-error
+ 	 */
  	public void write65536LongArray(byte[] a) throws IOException {
  		if (a.length > Short.MAX_VALUE) {
***************
*** 97,100 ****
--- 113,118 ----
  	 * @param a
  	 *            the short to serialize
+ 	 * @throws IOException
+ 	 *            in case of an IO-error
  	 */
  	public void write(short a) throws IOException {
***************
*** 112,115 ****
--- 130,135 ----
  	 * @param a
  	 *            the int to serialize
+ 	 * @throws IOException
+ 	 *            in case of an IO-error
  	 */
  	public void write(int a) throws IOException {
***************
*** 131,134 ****
--- 151,156 ----
  	 * @param a
  	 *            the int to serialize
+ 	 * @throws IOException
+ 	 *            in case of an IO-error
  	 */
  	public void write(float a) throws IOException {
***************
*** 151,154 ****
--- 173,178 ----
  	 * @param a
  	 *            the String to serialize
+ 	 * @throws IOException
+ 	 *            in case of an IO-error
  	 */
  	public void write(String a) throws IOException, UnsupportedEncodingException {
***************
*** 161,164 ****
--- 185,190 ----
  	 * @param a
  	 *            the String to serialize
+ 	 * @throws IOException
+ 	 *            in case of an IO-error
  	 */
  	public void write255LongString(String a) throws IOException, UnsupportedEncodingException {
***************
*** 166,169 ****
--- 192,204 ----
  	}
  
+ 	/**
+ 	/**
+ 	 * Add a long string to the serializer, using UTF-8 encoding
+ 	 *
+ 	 * @param a
+ 	 *            the String to serialize
+ 	 * @throws IOException
+ 	 *            in case of an IO-error
+ 	 */
  	public void write65536LongString(String a) throws IOException, UnsupportedEncodingException {
  		write65536LongArray(a.getBytes("UTF-8"));
***************
*** 175,178 ****
--- 210,215 ----
  	 * @param a
  	 *            the String array to serialize
+ 	 * @throws IOException
+ 	 *            in case of an IO-error
  	 */
  	public void write(String[] a) throws IOException {

Index: Serializable.java
===================================================================
RCS file: /cvsroot/arianne/marauroa/src/marauroa/common/net/Serializable.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** Serializable.java	9 Apr 2007 14:39:56 -0000	1.4
--- Serializable.java	4 Nov 2007 20:47:28 -0000	1.5
***************
*** 13,16 ****
--- 13,18 ----
  package marauroa.common.net;
  
+ import java.io.IOException;
+ 
  /**
   * Interface of all the object that wants to be able to be converted into a
***************
*** 19,26 ****
  public interface Serializable {
  
! 	/** Method to convert the object into a stream */
  	void writeObject(marauroa.common.net.OutputSerializer out) throws java.io.IOException;
  
! 	/** Method to build the object from a stream of bytes */
  	void readObject(marauroa.common.net.InputSerializer in) throws java.io.IOException;
  }
--- 21,38 ----
  public interface Serializable {
  
! 	/**
! 	 * Method to convert the object into a stream
! 	 *
! 	 * @param out OutputSerializer to write the object to
! 	 * @throws IOException in case of an IO-error
! 	 */
  	void writeObject(marauroa.common.net.OutputSerializer out) throws java.io.IOException;
  
! 	/** 
! 	 * Method to build the object from a stream of bytes
! 	 *
! 	 * @param in InputSerializer to read from
! 	 * @throws IOException in case of an IO-error
! 	 */
  	void readObject(marauroa.common.net.InputSerializer in) throws java.io.IOException;
  }