GOSSIP-20 Updated Javadocs to reflect URI objects, removed hostname and port references

This commit is contained in:
Rishabh Patel
2016-08-02 14:11:23 -07:00
committed by Rishabh Patel
parent c4cb0d7c6c
commit 4e13c899f0
3 changed files with 13 additions and 17 deletions

View File

@ -35,7 +35,7 @@ public abstract class GossipMember implements Comparable<GossipMember> {
protected final String clusterName; protected final String clusterName;
/** /**
* The purpose of the id field is to be able for nodes to identify themselves beyond there * The purpose of the id field is to be able for nodes to identify themselves beyond their
* host/port. For example an application might generate a persistent id so if they rejoin the * host/port. For example an application might generate a persistent id so if they rejoin the
* cluster at a different host and port we are aware it is the same node. * cluster at a different host and port we are aware it is the same node.
*/ */
@ -43,15 +43,13 @@ public abstract class GossipMember implements Comparable<GossipMember> {
/** /**
* Constructor. * Constructor.
* *
* @param host * @param uri
* The hostname or IP address. * A URI object containing IP/hostname and port
* @param port
* The port number.
* @param heartbeat * @param heartbeat
* The current heartbeat. * The current heartbeat
* @param id * @param id
* an id that may be replaced after contact * An id that may be replaced after contact
*/ */
public GossipMember(String clusterName, URI uri, String id, long heartbeat) { public GossipMember(String clusterName, URI uri, String id, long heartbeat) {
this.clusterName = clusterName; this.clusterName = clusterName;

View File

@ -30,12 +30,10 @@ public class RemoteGossipMember extends GossipMember {
/** /**
* Constructor. * Constructor.
* *
* @param hostname * @param uri
* The hostname or IP address. * A URI object containing IP/hostname and port
* @param port
* The port number.
* @param heartbeat * @param heartbeat
* The current heartbeat. * The current heartbeat
*/ */
public RemoteGossipMember(String clusterName, URI uri, String id, long heartbeat) { public RemoteGossipMember(String clusterName, URI uri, String id, long heartbeat) {
super(clusterName, uri, id, heartbeat); super(clusterName, uri, id, heartbeat);

View File

@ -58,8 +58,8 @@ public class StartupSettings {
* *
* @param id * @param id
* The id to be used for this service * The id to be used for this service
* @param port * @param uri
* The port to start the service on. * A URI object containing IP/hostname and port
* @param logLevel * @param logLevel
* unused * unused
*/ */
@ -80,8 +80,8 @@ public class StartupSettings {
* *
* @param id * @param id
* The id to be used for this service * The id to be used for this service
* @param port * @param uri
* The port to start the service on. * A URI object containing IP/hostname and port
*/ */
public StartupSettings(String id, URI uri, GossipSettings gossipSettings, String cluster) { public StartupSettings(String id, URI uri, GossipSettings gossipSettings, String cluster) {
this.id = id; this.id = id;