#107 Improvements for Command example JavaDocs
This commit is contained in:
@ -3,15 +3,15 @@ package com.iluwatar.command;
|
|||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* In Command pattern actions are objects that can be executed and undone.
|
* In Command pattern actions are objects that can be executed and undone.
|
||||||
*
|
* <p>
|
||||||
* Four terms always associated with the command pattern are command, receiver, invoker and client. A command
|
* Four terms always associated with the command pattern are command, receiver, invoker and client. A command
|
||||||
* object (spell) knows about receiver (target) and invokes a method of the receiver. Values for parameters of
|
* object (spell) knows about the receiver (target) and invokes a method of the receiver. Values for parameters of
|
||||||
* the receiver method are stored in the command. The receiver then does the work. An invoker object (wizard)
|
* the receiver method are stored in the command. The receiver then does the work. An invoker object (wizard)
|
||||||
* knows how to execute a command, and optionally does bookkeeping about the command execution. The invoker
|
* knows how to execute a command, and optionally does bookkeeping about the command execution. The invoker
|
||||||
* does not know anything about a concrete command, it knows only about command interface. Both an invoker object
|
* does not know anything about a concrete command, it knows only about command interface. Both an invoker object
|
||||||
* and several command objects are held by a client object (app). The client decides which commands to execute at
|
* and several command objects are held by a client object (app). The client decides which commands to execute at
|
||||||
* which points. To execute a command, it passes the command object to the invoker object.
|
* which points. To execute a command, it passes the command object to the invoker object.
|
||||||
*
|
* <p>
|
||||||
* In other words, in this example the wizard casts spells on the goblin. The wizard keeps track of the previous
|
* In other words, in this example the wizard casts spells on the goblin. The wizard keeps track of the previous
|
||||||
* spells cast, so it is easy to undo them. In addition, the wizard keeps track of the spells undone, so they
|
* spells cast, so it is easy to undo them. In addition, the wizard keeps track of the spells undone, so they
|
||||||
* can be redone.
|
* can be redone.
|
||||||
@ -20,6 +20,10 @@ package com.iluwatar.command;
|
|||||||
*/
|
*/
|
||||||
public class App {
|
public class App {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Program entry point
|
||||||
|
* @param args command line args
|
||||||
|
*/
|
||||||
public static void main(String[] args) {
|
public static void main(String[] args) {
|
||||||
Wizard wizard = new Wizard();
|
Wizard wizard = new Wizard();
|
||||||
Goblin goblin = new Goblin();
|
Goblin goblin = new Goblin();
|
||||||
|
@ -1,14 +1,19 @@
|
|||||||
package com.iluwatar.command;
|
package com.iluwatar.command;
|
||||||
|
|
||||||
import org.junit.Test;
|
import org.junit.Test;
|
||||||
|
|
||||||
import com.iluwatar.command.App;
|
import com.iluwatar.command.App;
|
||||||
|
|
||||||
public class AppTest {
|
/**
|
||||||
|
*
|
||||||
@Test
|
* Application test
|
||||||
public void test() {
|
*
|
||||||
String[] args = {};
|
*/
|
||||||
App.main(args);
|
public class AppTest {
|
||||||
}
|
|
||||||
}
|
@Test
|
||||||
|
public void test() {
|
||||||
|
String[] args = {};
|
||||||
|
App.main(args);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Reference in New Issue
Block a user