Permalink
Browse files

repaired javadoc so that I can publish

SBT is being a bit strict about javadoc errors.
  • Loading branch information...
channingwalton committed Jun 16, 2014
1 parent eca70a5 commit 588b7151e989ed690d545a82e4dffbdc64e20bcd
@@ -28,14 +28,14 @@
/**
* Encode the given object into any byte array required
* @param field
* @param field the field to write
* @return the encoded field as a byte array
*/
public byte [] writeField(Object field);
/**
* Decode the byte array to create the object field
* @param fieldBytes
* @param fieldBytes the bytes to read
* @return the object created from the byte array
*/
public Object readField(byte [] fieldBytes);
@@ -39,7 +39,7 @@
* in milli-seconds that the objects will 'live' in the Space.
*
* @param entries - The object to put in the Space
* @param leaseTime - The time in milliseconds the objects will live in the Space
* @param lease - The time in milliseconds the objects will live in the Space
* @return leaseTime - The space can return a shorter lease than the requested
* lease time. To be sure that your object has been leased for the given time
* check that the returned lease is the same as the requested lease.
@@ -32,7 +32,11 @@
/**
* @deprecated
* This method it will be removed at version 2.0
* This method will be removed at version 2.0
* @param template - the template to match to triger this notify
* @param handler - An object that implements the NotifyHandler interface
* @param leaseTime - The time in milliseconds the template will live in the Space
* @return boolen - Setup ok
*/
boolean notify(Object template, NotifyHandler handler, long leaseTime);
@@ -32,6 +32,7 @@
* object.
*
* If you don't need the returned entry then use a plain NotifyHandler
* @param entry the object matching the template
*/
void templateMatched(Object entry);
@@ -80,31 +80,31 @@ public FlyCache() {
/**
* Register a handler that wants to know if a fly instance has been started
* @param handler
* @param handler the handler to register
*/
public void registerDiscoveredHandler(FlyDiscoveredHandler handler) {
discoveredHandlers.add(handler);
}
/**
* No longer inerested in discoveries
* @param handler
* @param handler the handler to remove
*/
public void removeDiscoveredHandler(FlyDiscoveredHandler handler) {
discoveredHandlers.remove(handler);
}
/**
* Register a handler that wants to know if a fly instance has been stopped
* @param handler
* @param handler the lost handler to register
*/
public void registerLostHandler(FlyLostHandler handler) {
lostHandlers.add(handler);
}
/**
* No longer inerested in removed events
* @param handler
* @param handler the lost handler to remove
*/
public void removeLostHandler(FlyLostHandler handler) {
lostHandlers.remove(handler);
@@ -51,7 +51,7 @@ public FlyFinder() {
/**
* Use the supplied field codec to use non java serialized entries
*
* @param fieldCodec
* @param fieldCodec the field codec to use non java serialized entries
*/
public FlyFinder(FieldCodec fieldCodec) {
this.fieldCodec = fieldCodec;
@@ -62,10 +62,11 @@ public FlyPinger(long pingTimeOut) {
* Send a ping message to a Fly Space running on the given Address
* prefer the method that takes an InetAddress. Name to address
* conversion can be very slow on some platforms
* @param host
* @return String [] of tags or null array for failed ping.
* @param host the host to ping
* @return String[] of tags or null array for failed ping.
* @throws java.net.UnknownHostException if the host cannont be found
*/
public String [] ping(String host) throws UnknownHostException {
public String[] ping(String host) throws UnknownHostException {
InetAddress addr = InetAddress.getByName(host);
return ping(addr);
}
@@ -75,10 +76,10 @@ public FlyPinger(long pingTimeOut) {
/**
* Send a ping message to a Fly Space running on the given InetAddress and
* port.
* @param addr
* @return String [] of tags or null array for failed ping.
* @param addr the address to ping
* @return String[] of tags or null array for failed ping.
*/
public String [] ping(InetAddress addr) {
public String[] ping(InetAddress addr) {
String [] tags = null;
Socket sock = null;
try {
@@ -99,8 +99,8 @@ public void setFlyTags(String[] flyTags) {
* Test if the tags in this server rep match the seach tags
*
*
* @param The tags are being search for by the user
* @return
* @param tags The tags are being search for by the user
* @return true if the tags match, false otherwise
*/
public boolean tagsMatch(String[] tags) {
// if the tags from the space are null it doenst exist

0 comments on commit 588b715

Please sign in to comment.