Changed the documentation of some files to document things that have changed since last commit.

Voter-Registry
Vladimir Eliezer Tokarev 2016-03-18 10:53:01 -07:00
parent c767d8af58
commit 8140dcd516
2 changed files with 9 additions and 9 deletions

View File

@ -27,22 +27,22 @@ public interface VoterRegistry {
/** /**
* Adds new voter to the bulletin-board * Adds new voter to the bulletin-board
* Passes true to callBack.handleResult if the actions succeeded else * Passes true to callback.OnSuccess if the actions succeeded else
* call the onFailure method of the callback with the arisen error * call the onFailure method of the callback with the arisen error
* *
* @param voterInfo protobuff object that represents voter information * @param voterInfo protobuff object that represents voter information
* @param callBack when the adding voter done callBack.handleResult will be called * @param callBack when the adding voter done callback.OnSuccess will be called
* @throws SignatureException * @throws SignatureException
*/ */
void addVoter(VoterInfo voterInfo, FutureCallback<Boolean> callBack) throws SignatureException; void addVoter(VoterInfo voterInfo, FutureCallback<Boolean> callBack) throws SignatureException;
/** /**
* Adding given voter to given group * Adding given voter to given group
* Passes the group to callBack.handleResult if the actions succeeded else * Passes the group to callback.OnSuccess if the actions succeeded else
* call the onFailure method of the callback with the arisen error * call the onFailure method of the callback with the arisen error
* *
* @param voterRegistryMessage protobuff object that is coupling of voterId to groupId * @param voterRegistryMessage protobuff object that is coupling of voterId to groupId
* @param callBack when the adding voter done callBack.handleResult will be called * @param callBack when the adding voter done callback.OnSuccess will be called
* @throws SignatureException * @throws SignatureException
* @throws IOException * @throws IOException
*/ */
@ -50,11 +50,11 @@ public interface VoterRegistry {
/** /**
* Sets that the voter have voted * Sets that the voter have voted
* Passes true to callBack.handleResult if the actions succeeded else * Passes true to callback.OnSuccess if the actions succeeded else
* call the onFailure method of the callback with the arisen error * call the onFailure method of the callback with the arisen error
* *
* @param voterId protobuff object that represent the voter that have voted * @param voterId protobuff object that represent the voter that have voted
* @param callBack when the adding voter done callBack.handleResult will be called * @param callBack when the adding voter done callback.OnSuccess will be called
* @throws SignatureException * @throws SignatureException
*/ */
void setVoted(VoterID voterId, FutureCallback<Boolean> callBack) throws SignatureException; void setVoted(VoterID voterId, FutureCallback<Boolean> callBack) throws SignatureException;
@ -65,7 +65,7 @@ public interface VoterRegistry {
* call the onFailure method of the callback with the arisen error * call the onFailure method of the callback with the arisen error
* *
* @param voterID protobuff object that represent the voter * @param voterID protobuff object that represent the voter
* @param callBack when the adding voter done callBack.handleResult will be called * @param callBack when the adding voter done callback.OnSuccess will be called
*/ */
void getGroups(VoterID voterID, FutureCallback<List<meerkat.protobuf.VoterRegistry.GroupID>> callBack); void getGroups(VoterID voterID, FutureCallback<List<meerkat.protobuf.VoterRegistry.GroupID>> callBack);
@ -75,7 +75,7 @@ public interface VoterRegistry {
* call the onFailure method of the callback with the arisen error * call the onFailure method of the callback with the arisen error
* *
* @param voterID protobuff object that represent the voter * @param voterID protobuff object that represent the voter
* @param callBack when the adding voter done callBack.handleResult will be called * @param callBack when the adding voter done callback.OnSuccess will be called
*/ */
void getVoter(VoterID voterID, FutureCallback<VoterInfo> callBack); void getVoter(VoterID voterID, FutureCallback<VoterInfo> callBack);

View File

@ -44,7 +44,7 @@ import static meerkat.util.BulletinBoardUtils.getLatestMessage;
* NOTE: for most of this tests to pass there should run BulletinBoardServer * NOTE: for most of this tests to pass there should run BulletinBoardServer
* that should be reachable on BULLETIN_BOARD_SERVER_ADDRESS * that should be reachable on BULLETIN_BOARD_SERVER_ADDRESS
*/ */
public class SimpleRegistryTest /**extends TestCase**/ { public class SimpleRegistryTest {
private Collection<DigitalSignature> signers; private Collection<DigitalSignature> signers;
private AsyncBulletinBoardClient bulletinBoardClient; private AsyncBulletinBoardClient bulletinBoardClient;