[patterntesting-devel] CVS: PatternTesting05/src/test/java/patterntesting/java/runtime AbstractNullPointerTrapTest.java, 1.3, 1.4

[Oliver B. <ob...@us...>]

Update of /cvsroot/patterntesting/PatternTesting05/src/test/java/patterntesting/java/runtime
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv3076/src/test/java/patterntesting/java/runtime

Modified Files:
	AbstractNullPointerTrapTest.java 
Log Message:
lot of JavaDocs added

Index: AbstractNullPointerTrapTest.java
===================================================================
RCS file: /cvsroot/patterntesting/PatternTesting05/src/test/java/patterntesting/java/runtime/AbstractNullPointerTrapTest.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AbstractNullPointerTrapTest.java	27 Apr 2008 11:50:55 -0000	1.3
+++ AbstractNullPointerTrapTest.java	27 Apr 2008 16:56:59 -0000	1.4
@@ -26,9 +26,14 @@
 import junit.framework.TestCase;
 
 /**
+ * This is the test suite for {@link AbstractNullPointerTrap}.
+ * You can use it together with the {@link NullPointerTrap}
+ * to study how to use this abstract aspect.
+ * 
  * @author <a href="bo...@ja...">oliver</a>
  * @since 11.12.2007
  * @version $Revision$
+ * @see AbstractNullPointerTrap
  */
 public class AbstractNullPointerTrapTest extends TestCase {
 	
@@ -39,7 +44,17 @@
 		acceptNullArg(null);
 	}
 	
-	private final void acceptNullArg(String arg) {
+	/**
+	 * This test method is allowed to have <i>null</i> as argument.
+	 * It is defined as exceptional case in NullPointerTrap.
+	 * <br/>
+	 * This method is protected because it is an example and should be
+	 * visible in the JavaDoc.
+	 * 
+	 * @param arg can be null
+	 * @see NullPointerTrap
+	 */
+	protected final void acceptNullArg(String arg) {
 		if (arg == null) {
 			log.debug("(null) argument given");
 		}
@@ -54,7 +69,17 @@
 		}
 	}
 	
-	private final void acceptNoNullArg(String arg) {
+	/**
+	 * This method expects that no null argument is given. This precondition
+	 * is watched via the {@link NullPointerTrap}.
+	 * <br/>
+	 * This method is protected because it is an example and should be
+	 * visible in the JavaDoc.
+	 * 
+	 * @param arg cannot be null
+	 * @see NullPointerTrap
+	 */
+	protected final void acceptNoNullArg(String arg) {
 		log.debug(arg + " given with length=" + arg.length());
 	}
 	
@@ -63,7 +88,17 @@
 		assertNull(nullstring);
 	}
 	
-	private final String getNullString() {
+	/**
+	 * This test method is allowed to have <i>null</i> as return value.
+	 * It is defined as exceptional case in NullPointerTrap.
+	 * <br/>
+	 * This method is protected because it is an example and should be
+	 * visible in the JavaDoc.
+	 * 
+	 * @see NullPointerTrap
+	 * @return null
+	 */
+	protected final String getNullString() {
 		String nullstring = null;
 		return nullstring;
 	}
@@ -77,7 +112,17 @@
 		}
 	}
 	
-	private final String getUnallowedNullString() {
+	/**
+	 * This method should return no null value. This precondition
+	 * is watched via the {@link NullPointerTrap}.
+	 * <br/>
+	 * This method is protected because it is an example and should be
+	 * visible in the JavaDoc.
+	 * 
+	 * @see NullPointerTrap
+	 * @return not null
+	 */
+	protected final String getUnallowedNullString() {
 		return getNullString();
 	}
 	
@@ -89,8 +134,19 @@
 		acceptAll(null);
 	}
 	
+	/**
+	 * This test method is allowed to have <i>null</i> as argument.
+	 * This is marked by the NullArgsAllowed annotation.
+	 * <br/>
+	 * This method is protected because it is an example and should be
+	 * visible in the JavaDoc.
+	 * 
+	 * @param arg can be null
+	 * @see AbstractNullPointerTrap
+	 * @see NullArgsAllowed
+	 */
 	@NullArgsAllowed
-	private final void acceptAll(String nix) {
+	protected final void acceptAll(String nix) {
 		acceptNullArg(nix);
 	}
 	
@@ -99,8 +155,19 @@
 		assertNull(nix);
 	}
 	
+	/**
+	 * This method can return a null value. This is marked by the
+	 * MayReturnNull annotation.
+	 * <br/>
+	 * This method is protected because it is an example and should be
+	 * visible in the JavaDoc.
+	 * 
+	 * @see AbstractNullPointerTrap
+	 * @see MayReturnNull
+	 * @return null
+	 */
 	@MayReturnNull
-	private final Object getNullObject() {
+	protected final Object getNullObject() {
 		return null;
 	}
 
@@ -108,6 +175,9 @@
 
 /**
  * $Log$
+ * Revision 1.4  2008/04/27 16:56:59  oboehm
+ * lot of JavaDocs added
+ *
  * Revision 1.3  2008/04/27 11:50:55  oboehm
  * methods can now be marked as @MayReturnNull
  *