diff --git a/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/MainApp.java b/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/App.java similarity index 65% rename from model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/MainApp.java rename to model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/App.java index 73da4f733..ac6ccf091 100644 --- a/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/MainApp.java +++ b/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/App.java @@ -4,19 +4,23 @@ package com.iluwatar.model.view.presenter; * * The Model-View-Presenter(MVP) architectural pattern, helps us achieve what is * called "The separation of concerns" principle. This is accomplished - * by separating the application's logic(Model), GUIs(View), and finally - * the way that the user's actions update the application's logic(Presenter). - * - * In the following example, The FileLoader class represents the app's logic, - * the FileSelectorJFrame is the GUI and the FileSelectorPresenter is + * by separating the application's logic (Model), GUIs (View), and finally + * the way that the user's actions update the application's logic (Presenter). + *
+ * In the following example, The {@link FileLoader} class represents the app's logic, + * the {@link FileSelectorJFrame} is the GUI and the {@link FileSelectorPresenter} is * responsible to respond to users' actions. - * + *
* Finally, please notice the wiring between the Presenter and the View * and between the Presenter and the Model. * */ -public class MainApp { +public class App { + /** + * Program entry point + * @param args command line args + */ public static void main(String[] args) { FileLoader loader = new FileLoader(); FileSelectorJFrame jFrame = new FileSelectorJFrame(); diff --git a/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileLoader.java b/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileLoader.java index aef5bade9..96d843f83 100644 --- a/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileLoader.java +++ b/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileLoader.java @@ -7,7 +7,7 @@ import java.io.FileReader; /** * Every instance of this class represents the Model component in the * Model-View-Presenter architectural pattern. - * + *
* It is responsible for reading and loading the contents of a given file. */ public class FileLoader { @@ -51,9 +51,7 @@ public class FileLoader { /** * Sets the path of the file to be loaded, to the given value. - * - * @param fileName - * The path of the file to be loaded. + * @param fileName The path of the file to be loaded. */ public void setFileName(String fileName) { this.fileName = fileName; diff --git a/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorJFrame.java b/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorJFrame.java index be3c253ed..f4d24f59f 100644 --- a/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorJFrame.java +++ b/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorJFrame.java @@ -14,7 +14,7 @@ import javax.swing.JTextArea; import javax.swing.JTextField; /** - * This class is the GUI implementation of the View component In the + * This class is the GUI implementation of the View component in the * Model-View-Presenter pattern. */ public class FileSelectorJFrame extends JFrame implements FileSelectorView, diff --git a/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorPresenter.java b/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorPresenter.java index a7842e932..7119d60bf 100644 --- a/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorPresenter.java +++ b/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorPresenter.java @@ -3,7 +3,7 @@ package com.iluwatar.model.view.presenter; /** * Every instance of this class represents the Presenter component in the * Model-View-Presenter architectural pattern. - * + *
* It is responsible for reacting to the user's actions and update the View * component. */ @@ -21,19 +21,15 @@ public class FileSelectorPresenter { /** * Constructor - * - * @param view - * The view component that the presenter will interact with. + * @param view The view component that the presenter will interact with. */ public FileSelectorPresenter(FileSelectorView view) { this.view = view; } /** - * Sets the FileLoader object, to the value given as parameter. - * - * @param loader - * The new FileLoader object(the Model component). + * Sets the {@link FileLoader} object, to the value given as parameter. + * @param loader The new {@link FileLoader} object(the Model component). */ public void setLoader(FileLoader loader) { this.loader = loader; diff --git a/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorStub.java b/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorStub.java index 7aa88e922..d0cec4c40 100644 --- a/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorStub.java +++ b/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorStub.java @@ -3,10 +3,10 @@ package com.iluwatar.model.view.presenter; /** * Every instance of this class represents the Stub component in the * Model-View-Presenter architectural pattern. - * + *
* The stub implements the View interface and it is useful when we want the test * the reaction to user events, such as mouse clicks. - * + *
* Since we can not test the GUI directly, the MVP pattern provides this * functionality through the View's dummy implementation, the Stub. */ diff --git a/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorView.java b/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorView.java index e4a7efaee..8cd265f9b 100644 --- a/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorView.java +++ b/model-view-presenter/src/main/java/com/iluwatar/model/view/presenter/FileSelectorView.java @@ -23,9 +23,7 @@ public interface FileSelectorView { /** * Sets the presenter component, to the one given as parameter. - * - * @param presenter - * The new presenter component. + * @param presenter The new presenter component. */ public void setPresenter(FileSelectorPresenter presenter); @@ -36,9 +34,7 @@ public interface FileSelectorView { /** * Sets the file's name, to the value given as parameter. - * - * @param name - * The new name of the file. + * @param name The new name of the file. */ public void setFileName(String name); @@ -49,17 +45,13 @@ public interface FileSelectorView { /** * Displays a message to the users. - * - * @param message - * The message to be displayed. + * @param message The message to be displayed. */ public void showMessage(String message); /** * Displays the data to the view. - * - * @param data - * The data to be written. + * @param data The data to be written. */ public void displayData(String data); }