Skip to content

Commit

Permalink
Implemented documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Paroca72 committed Jun 21, 2016
1 parent 744e31b commit 9f0b88b
Showing 1 changed file with 1 addition and 29 deletions.
30 changes: 1 addition & 29 deletions ScObserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,41 +7,13 @@ For have a complete control of the class changes I can suggest to look into Obse

#### Methods

- **boolean isChanged() **<br />
- **boolean isChanged()**<br />
Check if have some changes and update the current status.

- **void exclude(String... methodsName)**<br />
Exclude the methods passed from checking


### Listener
```java
public interface CheckerListener {

void onSuccess();

void onFail();

void onChangeState(boolean result);

}
```


### Overridable methods
Since this class must be extended you can override some methods for your scope.

- **public void onSuccess()**<br />
Called on success (when <code>check()</code> methods return <code>true</code>).
- **public void onFail()**<br />
Called on fail (when <code>check()</code> methods return <code>false</code>).
- **public void onChangeState(boolean result)**<br />
Called on status change. The <code>result</code> variable contain the <code>check()</code> returned value.


### Example
For an example please take a look the demo section in the project structure.

#License
<pre>
Copyright 2015 Samuele Carassai
Expand Down

0 comments on commit 9f0b88b

Please sign in to comment.