iluwatar#107 Front Controller example JavaDoc

iluwatar · iluwatar · commit c5c4a68c6f9c · 2015-08-18T22:54:15.000+03:00
diff --git a/front-controller/src/main/java/com/iluwatar/front/controller/App.java b/front-controller/src/main/java/com/iluwatar/front/controller/App.java
@@ -4,22 +4,26 @@
  * 
  * The Front Controller is a presentation tier pattern. Essentially it defines a
  * controller that handles all requests for a web site.
- * 
+ * <p>
  * The Front Controller pattern consolidates request handling through a single handler
- * object (FrontController). This object can carry out the common the behavior such as
+ * object ({@link FrontController}). This object can carry out the common the behavior such as
  * authorization, request logging and routing requests to corresponding views.
- * 
- * Typically the requests are mapped to command objects (Command) which then display
- * the correct view (View).
- * 
- * In this example we have implemented two views: ArcherView and CatapultView. These
- * are displayed by sending correct request to the FrontController object. For example,
- * the ArcherView gets displayed when FrontController receives request "Archer". When
- * the request is unknown, we display the error view (ErrorView).
+ * <p>
+ * Typically the requests are mapped to command objects ({@link Command}) which then display
+ * the correct view ({@link View}).
+ * <p>
+ * In this example we have implemented two views: {@link ArcherView} and {@link CatapultView}. These
+ * are displayed by sending correct request to the {@link FrontController} object. For example,
+ * the {@link ArcherView} gets displayed when {@link FrontController} receives request "Archer". When
+ * the request is unknown, we display the error view ({@link ErrorView}).
  *
  */
 public class App {
 	
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 		FrontController controller = new FrontController();
 		controller.handleRequest("Archer");
diff --git a/front-controller/src/main/java/com/iluwatar/front/controller/ApplicationException.java b/front-controller/src/main/java/com/iluwatar/front/controller/ApplicationException.java
@@ -1,8 +1,15 @@
 package com.iluwatar.front.controller;
 
+/**
+ * 
+ * Custom exception type
+ *
+ */
 public class ApplicationException extends RuntimeException {
 
-    public ApplicationException(Throwable cause) {
+	private static final long serialVersionUID = 1L;
+
+	public ApplicationException(Throwable cause) {
         super(cause);
     }
 }
diff --git a/front-controller/src/test/java/com/iluwatar/front/controller/AppTest.java b/front-controller/src/test/java/com/iluwatar/front/controller/AppTest.java
@@ -4,6 +4,11 @@
 
 import com.iluwatar.front.controller.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 	
 	@Test
