GOSSIP-32 Javadoc errors blocking release

This commit is contained in:
Edward Capriolo
2016-11-09 13:49:30 -05:00
parent 5352dc57ff
commit 42e4ac786d
4 changed files with 18 additions and 11 deletions

View File

@ -16,8 +16,7 @@
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
--> -->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<parent> <parent>
@ -29,7 +28,7 @@
<groupId>org.apache.gossip</groupId> <groupId>org.apache.gossip</groupId>
<artifactId>gossip</artifactId> <artifactId>gossip</artifactId>
<name>gossip</name> <name>gossip</name>
<version>0.1.0-incubating-SNAPSHOT</version> <version>0.1.0-incubating</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<description>A peer to peer cluster discovery service</description> <description>A peer to peer cluster discovery service</description>
<url>http://gossip.incubator.apache.org/</url> <url>http://gossip.incubator.apache.org/</url>
@ -66,7 +65,7 @@
<connection>scm:git:git@github.com:apache/incubator-gossip.git</connection> <connection>scm:git:git@github.com:apache/incubator-gossip.git</connection>
<developerConnection>scm:git:https://git-wip-us.apache.org/repos/asf/incubator-gossip.git</developerConnection> <developerConnection>scm:git:https://git-wip-us.apache.org/repos/asf/incubator-gossip.git</developerConnection>
<url>scm:git:git@github.com:apache/incubator-gossip.git</url> <url>scm:git:git@github.com:apache/incubator-gossip.git</url>
<tag>HEAD</tag> <tag>gossip-0.1.0-incubating</tag>
</scm> </scm>
<issueManagement> <issueManagement>

View File

@ -23,7 +23,6 @@ import java.net.URI;
/** /**
* A abstract class representing a gossip member. * A abstract class representing a gossip member.
* *
* @author joshclemm, harmenw
*/ */
public abstract class GossipMember implements Comparable<GossipMember> { public abstract class GossipMember implements Comparable<GossipMember> {
@ -44,6 +43,8 @@ public abstract class GossipMember implements Comparable<GossipMember> {
/** /**
* Constructor. * Constructor.
* *
* @param clusterName
* The name of the cluster
* @param uri * @param uri
* A URI object containing IP/hostname and port * A URI object containing IP/hostname and port
* @param heartbeat * @param heartbeat
@ -69,7 +70,7 @@ public abstract class GossipMember implements Comparable<GossipMember> {
/** /**
* The member address in the form IP/host:port Similar to the toString in * @return The member address in the form IP/host:port Similar to the toString in
* {@link InetSocketAddress} * {@link InetSocketAddress}
*/ */
public String getAddress() { public String getAddress() {

View File

@ -84,8 +84,9 @@ public class GossipService {
} }
/** /**
* Gossip data in a namespace that is per-node { node-id { key->value } } * Gossip data in a namespace that is per-node { node-id { key, value } }
* @param message * @param message
* message to be gossip'ed across the cluster
*/ */
public void gossipPerNodeData(GossipDataMessage message){ public void gossipPerNodeData(GossipDataMessage message){
gossipManager.gossipPerNodeData(message); gossipManager.gossipPerNodeData(message);
@ -93,17 +94,21 @@ public class GossipService {
/** /**
* Retrieve per-node gossip data by key * Retrieve per-node gossip data by key
*
* @param nodeId * @param nodeId
* the id of the node that owns the data
* @param key * @param key
* @return return the value if found or null if not found or expired * the key in the per-node map to find the data
* @return the value if found or null if not found or expired
*/ */
public GossipDataMessage findPerNodeData(String nodeId, String key){ public GossipDataMessage findPerNodeData(String nodeId, String key){
return getGossipManager().findPerNodeGossipData(nodeId, key); return getGossipManager().findPerNodeGossipData(nodeId, key);
} }
/** /**
* Gossip shared data *
* @param message * @param message
* Shared data to gossip around the cluster
*/ */
public void gossipSharedData(SharedGossipDataMessage message){ public void gossipSharedData(SharedGossipDataMessage message){
gossipManager.gossipSharedData(message); gossipManager.gossipSharedData(message);
@ -111,8 +116,9 @@ public class GossipService {
/** /**
* *
* @param key the key to search for * @param key
* @return * the key to search for
* @return the value associated with given key
*/ */
public SharedGossipDataMessage findSharedData(String key){ public SharedGossipDataMessage findSharedData(String key){
return getGossipManager().findSharedGossipData(key); return getGossipManager().findSharedGossipData(key);

View File

@ -37,6 +37,7 @@ public class LocalGossipMember extends GossipMember {
* @param uri * @param uri
* The uri of the member * The uri of the member
* @param id * @param id
* id of the node
* @param heartbeat * @param heartbeat
* The current heartbeat. * The current heartbeat.
* @param notificationListener * @param notificationListener