Skip to content

Update README.md #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JuliaDanilyuk wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
## CommandActionService
ActionService for [Janet](https://github.com/techery/janet) which delegates job execution back to command action.
ActionService for [Janet](https://github.com/techery/janet) delegates any job execution back to the command action.

### Getting Started
##### 1. Define service and add it to `Janet`
##### 1. Define a service and add it to `Janet`
```java
Janet janet = new Janet.Builder().addService(new CommandActionService()).build();
```

##### 2. Define command action class
##### 2. Define a command action class
```java
@CommandAction
class CopyBitmapToFileCommand extends Command<File> {
Expand Down Expand Up @@ -46,13 +46,13 @@ class CopyBitmapToFileCommand extends Command<File> {

```

* Each action is an individual class that contains runnable logic;
* Each action is an individual class that contains a runnable logic;
* It must be annotated with `@CommandAction` and must extend `Command`;
* Real job is defined by overriden `void run()` method which is called upon action sending;
* `CommandCallback` methods should be called to indicate command result;
* Cleanup on cancelation is available via overriden `void cancel()`.
* A real job is defined by the overriden `void run()` method, which is called once the action is sent;
* `CommandCallback` methods should be called to indicate a command result;
* The cleanup on cancelation is available via overriden `void cancel()`.

##### 3. Use `ActionPipe` to send/observe action
##### 3. Use `ActionPipe` to send/observe an action
```java
ActionPipe<CopyBitmapToFileCommand> actionPipe = janet.createPipe(CopyBitmapToFileCommand.class);
actionPipe
Expand Down