[jboss-cvs] JBossAS SVN: r66912 - in projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted: commandLineClient/src/main/java/org/jboss/example/client and 5 other directories.

jboss-cvs-commits at lists.jboss.org jboss-cvs-commits at lists.jboss.org
Fri Nov 9 06:47:02 EST 2007


Author: newtonm
Date: 2007-11-09 06:47:02 -0500 (Fri, 09 Nov 2007)
New Revision: 66912

Modified:
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/auditAspect/src/main/java/org/jboss/example/aspect/AuditAspect.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/Client.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/ConsoleInput.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/EmbeddedBootstrap.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/UserInterface.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/test/java/org/jboss/example/client/ClientTestCase.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/test/java/org/jboss/example/client/ClientTestSuite.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/test/java/org/jboss/example/client/MockUserInterface.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/Address.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/Employee.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/HRManager.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/util/AgeBasedSalaryStrategy.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/util/LocationBasedSalaryStrategy.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/util/SalaryStrategy.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerAgeBasedTestCase.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerLocationBasedTestCase.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerTest.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerTestCase.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerTestSuite.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/util/AgeBasedSalaryTestCase.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/util/LocationBasedSalaryTestCase.java
   projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/util/SalaryStrategyTestSuite.java
Log:
Added Javadoc comments and author tags.

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/auditAspect/src/main/java/org/jboss/example/aspect/AuditAspect.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/auditAspect/src/main/java/org/jboss/example/aspect/AuditAspect.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/auditAspect/src/main/java/org/jboss/example/aspect/AuditAspect.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -2,6 +2,13 @@
 
 import org.jboss.aop.joinpoint.Invocation;
 
+/**
+ * An auditing aspect to keep track of all invocations made to
+ * methods on an object. A log file is used to store the audit
+ * information.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class AuditAspect {
 
 	public Object audit(Invocation inv) throws Throwable {

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/Client.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/Client.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/Client.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -15,10 +15,15 @@
 import org.jboss.example.service.util.SalaryStrategy;
 import org.jboss.kernel.Kernel;
 import org.jboss.kernel.spi.dependency.KernelController;
-import org.jboss.kernel.spi.dependency.KernelControllerContext;
 import org.jboss.kernel.spi.registry.KernelBus;
-import org.jboss.kernel.spi.registry.KernelRegistry;
 
+/**
+ * A simple client that starts JBoss Microcontainer and then  
+ * uses the command line as a User Interface to pass requests
+ * to the Human Resources service either directly or via the bus.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class Client {
     
 	private boolean useBus = false;

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/ConsoleInput.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/ConsoleInput.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/ConsoleInput.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -10,6 +10,12 @@
 import org.jboss.example.service.Address;
 import org.jboss.example.service.Employee;
 
+/**
+ * A simple Text User Interface (TUI) so a user can access
+ * the Human Resources service from the command line.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class ConsoleInput implements UserInterface {
 	
 	private static BufferedReader in = new BufferedReader(new InputStreamReader(System.in));

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/EmbeddedBootstrap.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/EmbeddedBootstrap.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/EmbeddedBootstrap.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -5,6 +5,12 @@
 import org.jboss.kernel.plugins.bootstrap.basic.BasicBootstrap;
 import org.jboss.kernel.plugins.deployment.xml.BasicXMLDeployer;
 
+/**
+ * Add a BasicXMLDeployer to the BasicBootstrap so that we can parse
+ * XML descriptors for the beans (*-beans.xml).
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class EmbeddedBootstrap extends BasicBootstrap {
 	
 	protected BasicXMLDeployer deployer;

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/UserInterface.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/UserInterface.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/main/java/org/jboss/example/client/UserInterface.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -7,6 +7,12 @@
 import org.jboss.example.service.Address;
 import org.jboss.example.service.Employee;
 
+/**
+ * Allow different implementations of a user interface to be used.
+ * i.e. command line, Swing or even a mock for testing purposes.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public interface UserInterface {
 	Employee getEmployee() throws IOException;
 	Address getAddress() throws IOException;

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/test/java/org/jboss/example/client/ClientTestCase.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/test/java/org/jboss/example/client/ClientTestCase.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/test/java/org/jboss/example/client/ClientTestCase.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -2,6 +2,12 @@
 
 import junit.framework.TestCase;
 
+/**
+ * Use a mock User Interface to pass values into the client
+ * and check that the Human Resources service is called correctly.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class ClientTestCase extends TestCase
 {	
     public ClientTestCase(String name) {

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/test/java/org/jboss/example/client/ClientTestSuite.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/test/java/org/jboss/example/client/ClientTestSuite.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/test/java/org/jboss/example/client/ClientTestSuite.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -4,6 +4,11 @@
 import junit.framework.TestSuite;
 import junit.textui.TestRunner;
 
+/**
+ * Allow all Client tests to be run.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class ClientTestSuite extends TestSuite
 {
    public static void main(String[] args) {

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/test/java/org/jboss/example/client/MockUserInterface.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/test/java/org/jboss/example/client/MockUserInterface.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/commandLineClient/src/test/java/org/jboss/example/client/MockUserInterface.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -8,6 +8,11 @@
 import org.jboss.example.service.Address;
 import org.jboss.example.service.Employee;
 
+/**
+ * A mock user interface to simulate values being passed in by a user.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class MockUserInterface implements UserInterface {
 
 	public Address getAddress() throws IOException {

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/Address.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/Address.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/Address.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -1,5 +1,10 @@
 package org.jboss.example.service;
 
+/**
+ * A basic address.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class Address {
 
 	private int number;

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/Employee.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/Employee.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/Employee.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -3,6 +3,11 @@
 import java.text.SimpleDateFormat;
 import java.util.Date;
 
+/**
+ * A basic employee.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class Employee {
 
 	private String firstName;

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/HRManager.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/HRManager.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/HRManager.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -9,6 +9,8 @@
 /**
  * An HRManager (Human Resource Manager) keeps track
  * of a set of employees and their associated salaries.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
  */
 public class HRManager {
     
@@ -57,13 +59,11 @@
 	}
 	
 	public void setSalary(Employee employee, Integer salary) {
-		
 		if (employee == null || !employees.containsKey(employee)) {
 			return;
 		}
 		
 		int adjustedSalary = salary;
-		
 		if (salaryStrategy != null) {
 			adjustedSalary = salaryStrategy.checkSalary(employee, salary);
 		}

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/util/AgeBasedSalaryStrategy.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/util/AgeBasedSalaryStrategy.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/util/AgeBasedSalaryStrategy.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -6,6 +6,8 @@
 
 /**
  * Check that the salary is relative to the employee's age in years.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
  */
 public class AgeBasedSalaryStrategy implements SalaryStrategy {
 

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/util/LocationBasedSalaryStrategy.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/util/LocationBasedSalaryStrategy.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/util/LocationBasedSalaryStrategy.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -4,6 +4,8 @@
 
 /**
  * Check that the salary is relative to the employee's location.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
  */
 public class LocationBasedSalaryStrategy implements SalaryStrategy {
 

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/util/SalaryStrategy.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/util/SalaryStrategy.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/main/java/org/jboss/example/service/util/SalaryStrategy.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -3,7 +3,9 @@
 import org.jboss.example.service.Employee;
 
 /**
- * Apply some rules to calculate an employee's minimum and maximum salary. 
+ * Apply some rules to calculate an employee's minimum and maximum salary.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
  */
 public interface SalaryStrategy {
 

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerAgeBasedTestCase.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerAgeBasedTestCase.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerAgeBasedTestCase.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -2,6 +2,12 @@
 
 import org.jboss.example.service.HRManager;
 
+/**
+ * Check that the AgeBasedSalaryStrategy behaves as expected
+ * when used by the HRManager.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class HRManagerAgeBasedTestCase extends HRManagerTest
 {	
     public HRManagerAgeBasedTestCase(String name) {

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerLocationBasedTestCase.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerLocationBasedTestCase.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerLocationBasedTestCase.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -2,6 +2,12 @@
 
 import org.jboss.example.service.HRManager;
 
+/**
+ * Check that the LocationBasedSalaryStrategy behaves as expected
+ * when used by the HRManager.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class HRManagerLocationBasedTestCase extends HRManagerTest
 {	
     public HRManagerLocationBasedTestCase(String name) {

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerTest.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerTest.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerTest.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -4,6 +4,11 @@
 
 import org.jboss.test.kernel.junit.MicrocontainerTest;
 
+/**
+ * Setup a number of test employees for the various tests.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public abstract class HRManagerTest extends MicrocontainerTest
 {
 	protected Employee bob, rebecca, karen, joe;

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerTestCase.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerTestCase.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerTestCase.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -2,6 +2,12 @@
 
 import org.jboss.example.service.HRManager;
 
+/**
+ * Check that the HRManager behaves as expected when no
+ * salary strategy is used.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class HRManagerTestCase extends HRManagerTest
 {	
     public HRManagerTestCase(String name) {

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerTestSuite.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerTestSuite.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/HRManagerTestSuite.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -6,6 +6,11 @@
 import junit.framework.TestSuite;
 import junit.textui.TestRunner;
 
+/**
+ * Allow all HRManager tests to be run.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class HRManagerTestSuite extends TestSuite
 {
    public static void main(String[] args) {

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/util/AgeBasedSalaryTestCase.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/util/AgeBasedSalaryTestCase.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/util/AgeBasedSalaryTestCase.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -3,6 +3,11 @@
 import org.jboss.example.service.HRManagerTest;
 import org.jboss.example.service.util.SalaryStrategy;
 
+/**
+ * Check the behaviour of the AgeBasedSalaryStrategy.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class AgeBasedSalaryTestCase extends HRManagerTest
 {
 	public AgeBasedSalaryTestCase(String name) {

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/util/LocationBasedSalaryTestCase.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/util/LocationBasedSalaryTestCase.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/util/LocationBasedSalaryTestCase.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -3,6 +3,11 @@
 import org.jboss.example.service.HRManagerTest;
 import org.jboss.example.service.util.SalaryStrategy;
 
+/**
+ * Check the behaviour of the LocationBasedSalaryStrategy.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class LocationBasedSalaryTestCase extends HRManagerTest
 {
 	public LocationBasedSalaryTestCase(String name) {

Modified: projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/util/SalaryStrategyTestSuite.java
===================================================================
--- projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/util/SalaryStrategyTestSuite.java	2007-11-09 11:15:59 UTC (rev 66911)
+++ projects/microcontainer/trunk/docs/examples/User_Guide/gettingStarted/humanResourcesService/src/test/java/org/jboss/example/service/util/SalaryStrategyTestSuite.java	2007-11-09 11:47:02 UTC (rev 66912)
@@ -7,6 +7,11 @@
 import junit.framework.TestSuite;
 import junit.textui.TestRunner;
 
+/**
+ * Allow all SalaryStrategy tests to be run.
+ * 
+ * @author <a href="mailto:mark.newton at jboss.org">Mark Newton</a>
+ */
 public class SalaryStrategyTestSuite extends TestSuite
 {
    public static void main(String[] args) {




More information about the jboss-cvs-commits mailing list