[Arianne-commits] marboard/src/net/sf/arianne/marboard/server/core/parser RPClassParser.java, 1.8, 1.9 RPObjectParser.java, 1.4, 1.5

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

Update of /cvsroot/arianne/marboard/src/net/sf/arianne/marboard/server/core/parser
In directory sfp-cvsdas-1.v30.ch3.sourceforge.com:/tmp/cvs-serv6912/src/net/sf/arianne/marboard/server/core/parser

Modified Files:
	RPClassParser.java RPObjectParser.java 
Log Message:
added javadoc to the parser package

Index: RPClassParser.java
===================================================================
RCS file: /cvsroot/arianne/marboard/src/net/sf/arianne/marboard/server/core/parser/RPClassParser.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** RPClassParser.java	5 Sep 2009 13:17:40 -0000	1.8
--- RPClassParser.java	28 Feb 2010 21:31:52 -0000	1.9
***************
*** 49,52 ****
--- 49,57 ----
  	}
  
+ 	/**
+ 	 * validated the beginning of a line
+ 	 *
+ 	 * @throws ParseException in case of an invalid line
+ 	 */
  	void checkBeginning() throws ParseException {
  		int pos = text.indexOf("Class(");
***************
*** 56,59 ****
--- 61,69 ----
  	}
  
+ 	/**
+ 	 * validated the class name
+ 	 *
+ 	 * @throws ParseException in case of an invalid line
+ 	 */
  	int findEndOfClassname() throws ParseException {
  		int pos = text.indexOf("): ");
***************
*** 64,67 ****
--- 74,84 ----
  	}
  
+ 	/**
+ 	 * extracts the name of the RPClass
+ 	 *
+ 	 * @param end string index
+ 	 * @return name of RPClass
+ 	 * @throws ParseException in case the name is invalid
+ 	 */
  	String extractClassname(int end) throws ParseException {
  		String rpclass = text.substring(6, end);
***************
*** 72,75 ****
--- 89,98 ----
  	}
  
+ 	/**
+ 	 * validated that the RPClass is known
+ 	 *
+ 	 * @param rpclass name of RPClass
+ 	 * @throws ParseException in case the RPClass is not known
+ 	 */
  	void checkClassIsKnown(String rpclass) throws ParseException {
  		if (!RPClass.hasRPClass(rpclass)) {
***************
*** 78,81 ****
--- 101,110 ----
  	}
  
+ 	/**
+ 	 * validates that the rpclass is a subclass of shape
+ 	 *
+ 	 * @param rpclass name of RPClass to check
+ 	 * @throws ParseException in case it is not a subclass
+ 	 */
  	void checkClassInheritance(String rpclass) throws ParseException {
  		if (parent == null) {

Index: RPObjectParser.java
===================================================================
RCS file: /cvsroot/arianne/marboard/src/net/sf/arianne/marboard/server/core/parser/RPObjectParser.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** RPObjectParser.java	28 Feb 2010 01:38:58 -0000	1.4
--- RPObjectParser.java	28 Feb 2010 21:31:52 -0000	1.5
***************
*** 12,15 ****
--- 12,16 ----
   */
  public class RPObjectParser {
+ 
  	/**
  	 * parses the text
***************
*** 25,28 ****
--- 26,31 ----
  
  		new AttributesParser(text, object).parse();
+ 
+ 		// remove unwanted attributes
  		object.remove("id");
  		object.remove("z");