Author: markt
Date: Tue Sep 15 12:03:50 2015
New Revision: 1703164
URL: http://svn.apache.org/r1703164
Log:
Fix Javadoc
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/membership/Membership.java
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/membership/Membership.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/membership/Membership.java?rev=1703164&r1=1703163&r2=1703164&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/membership/Membership.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/membership/Membership.java Tue
Sep 15 12:03:50 2015
@@ -139,7 +139,10 @@ public class Membership implements Clone
/**
* Add a member to this component and sort array with memberComparator
+ *
* @param member The member to add
+ *
+ * @return The member entry created for this new member.
*/
public synchronized MbrEntry addMember(Member member) {
synchronized (membersLock) {
@@ -217,7 +220,10 @@ public class Membership implements Clone
}
/**
- * Returning that service has members or not
+ * Returning that service has members or not.
+ *
+ * @return <code>true</code> if there are one or more members, otherwise
+ * <code>false</code>
*/
public boolean hasMembers() {
return members.length > 0 ;
@@ -241,8 +247,10 @@ public class Membership implements Clone
}
/**
- * Returning a list of all the members in the membership
+ * Returning a list of all the members in the membership.
* We not need a copy: add and remove generate new arrays.
+ *
+ * @return An array of the current members
*/
public Member[] getMembers() {
if(hasMembers()) {
@@ -293,15 +301,21 @@ public class Membership implements Clone
}
/**
- * Return the actual Member object
+ * Obtain the member associated with this entry.
+ *
+ * @return The member for this entry.
*/
public Member getMember() {
return mbr;
}
/**
- * Check if this dude has expired
+ * Check if this member has expired.
+ *
* @param maxtime The time threshold
+ *
+ * @return <code>true</code> if the member has expired, otherwise
+ * <code>false</false>
*/
public boolean hasExpired(long maxtime) {
long delta = System.currentTimeMillis() - lastHeardFrom;
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
