You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@curator.apache.org by dr...@apache.org on 2014/10/03 00:12:22 UTC
git commit: Fix broken javadoc
Repository: curator
Updated Branches:
refs/heads/master 63444f6a2 -> c846cf16e
Fix broken javadoc
Project: http://git-wip-us.apache.org/repos/asf/curator/repo
Commit: http://git-wip-us.apache.org/repos/asf/curator/commit/c846cf16
Tree: http://git-wip-us.apache.org/repos/asf/curator/tree/c846cf16
Diff: http://git-wip-us.apache.org/repos/asf/curator/diff/c846cf16
Branch: refs/heads/master
Commit: c846cf16e96b5a79d4e95fef5f292aa66ef206ec
Parents: 63444f6
Author: Scott Blum <dr...@apache.org>
Authored: Thu Oct 2 18:12:16 2014 -0400
Committer: Scott Blum <dr...@apache.org>
Committed: Thu Oct 2 18:12:16 2014 -0400
----------------------------------------------------------------------
.../curator/framework/CuratorFramework.java | 2 +-
.../framework/recipes/cache/TreeCacheEvent.java | 14 +++++++++-----
.../framework/recipes/leader/LeaderLatch.java | 20 +++++++++++---------
3 files changed, 21 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/curator/blob/c846cf16/curator-framework/src/main/java/org/apache/curator/framework/CuratorFramework.java
----------------------------------------------------------------------
diff --git a/curator-framework/src/main/java/org/apache/curator/framework/CuratorFramework.java b/curator-framework/src/main/java/org/apache/curator/framework/CuratorFramework.java
index 13cff30..9c23ddb 100644
--- a/curator-framework/src/main/java/org/apache/curator/framework/CuratorFramework.java
+++ b/curator-framework/src/main/java/org/apache/curator/framework/CuratorFramework.java
@@ -216,7 +216,7 @@ public interface CuratorFramework extends Closeable
/**
* Block until a connection to ZooKeeper is available or the maxWaitTime has been exceeded
- * @param maxWaitTime The maximum wait time. Specify a value <= 0 to wait indefinitely
+ * @param maxWaitTime The maximum wait time. Specify a value <= 0 to wait indefinitely
* @param units The time units for the maximum wait time.
* @return True if connection has been established, false otherwise.
* @throws InterruptedException If interrupted while waiting
http://git-wip-us.apache.org/repos/asf/curator/blob/c846cf16/curator-recipes/src/main/java/org/apache/curator/framework/recipes/cache/TreeCacheEvent.java
----------------------------------------------------------------------
diff --git a/curator-recipes/src/main/java/org/apache/curator/framework/recipes/cache/TreeCacheEvent.java b/curator-recipes/src/main/java/org/apache/curator/framework/recipes/cache/TreeCacheEvent.java
index 9548a14..c1fb1e5 100644
--- a/curator-recipes/src/main/java/org/apache/curator/framework/recipes/cache/TreeCacheEvent.java
+++ b/curator-recipes/src/main/java/org/apache/curator/framework/recipes/cache/TreeCacheEvent.java
@@ -49,50 +49,54 @@ public class TreeCacheEvent
/**
* Called when the connection has changed to {@link org.apache.curator.framework.state.ConnectionState#SUSPENDED}
- * <p/>
+ * <p>
* This is exposed so that users of the class can be notified of issues that *might* affect normal operation.
* The TreeCache is written such that listeners are not expected to do anything special on this
* event, except for those people who want to cause some application-specific logic to fire when this occurs.
* While the connection is down, the TreeCache will continue to have its state from before it lost
* the connection and after the connection is restored, the TreeCache will emit normal child events
* for all of the adds, deletes and updates that happened during the time that it was disconnected.
+ * </p>
*/
CONNECTION_SUSPENDED,
/**
* Called when the connection has changed to {@link org.apache.curator.framework.state.ConnectionState#RECONNECTED}
- * <p/>
+ * <p>
* This is exposed so that users of the class can be notified of issues that *might* affect normal operation.
* The TreeCache is written such that listeners are not expected to do anything special on this
* event, except for those people who want to cause some application-specific logic to fire when this occurs.
* While the connection is down, the TreeCache will continue to have its state from before it lost
* the connection and after the connection is restored, the TreeCache will emit normal child events
* for all of the adds, deletes and updates that happened during the time that it was disconnected.
+ * </p>
*/
CONNECTION_RECONNECTED,
/**
* Called when the connection has changed to {@link org.apache.curator.framework.state.ConnectionState#LOST}
- * <p/>
+ * <p>
* This is exposed so that users of the class can be notified of issues that *might* affect normal operation.
* The TreeCache is written such that listeners are not expected to do anything special on this
* event, except for those people who want to cause some application-specific logic to fire when this occurs.
* While the connection is down, the TreeCache will continue to have its state from before it lost
* the connection and after the connection is restored, the TreeCache will emit normal child events
* for all of the adds, deletes and updates that happened during the time that it was disconnected.
+ * </p>
*/
CONNECTION_LOST,
/**
* Posted after the initial cache has been fully populated.
- * <p/>
+ * <p>
* On startup, the cache synchronizes its internal
* state with the server, publishing a series of {@link #NODE_ADDED} events as new nodes are discovered. Once
* the cachehas been fully synchronized, this {@link #INITIALIZED} this event is published. All events
* published after this event represent actual server-side mutations.
- * <p/>
+ * </p><p>
* Note: because the initial population is inherently asynchronous, so it's possible to observe server-side changes
* (such as a {@link #NODE_UPDATED}) prior to this event being published.
+ * </p>
*/
INITIALIZED
}
http://git-wip-us.apache.org/repos/asf/curator/blob/c846cf16/curator-recipes/src/main/java/org/apache/curator/framework/recipes/leader/LeaderLatch.java
----------------------------------------------------------------------
diff --git a/curator-recipes/src/main/java/org/apache/curator/framework/recipes/leader/LeaderLatch.java b/curator-recipes/src/main/java/org/apache/curator/framework/recipes/leader/LeaderLatch.java
index 489cd7e..40d92e4 100644
--- a/curator-recipes/src/main/java/org/apache/curator/framework/recipes/leader/LeaderLatch.java
+++ b/curator-recipes/src/main/java/org/apache/curator/framework/recipes/leader/LeaderLatch.java
@@ -248,12 +248,13 @@ public class LeaderLatch implements Closeable
/**
* Attaches a listener to this LeaderLatch
- * <p/>
+ * <p>
* Attaching the same listener multiple times is a noop from the second time on.
- * <p/>
+ * </p><p>
* All methods for the listener are run using the provided Executor. It is common to pass in a single-threaded
* executor so that you can be certain that listener methods are called in sequence, but if you are fine with
* them being called out of order you are welcome to use multiple threads.
+ * </p>
*
* @param listener the listener to attach
*/
@@ -264,12 +265,13 @@ public class LeaderLatch implements Closeable
/**
* Attaches a listener to this LeaderLatch
- * <p/>
+ * <p>
* Attaching the same listener multiple times is a noop from the second time on.
- * <p/>
+ * </p><p>
* All methods for the listener are run using the provided Executor. It is common to pass in a single-threaded
* executor so that you can be certain that listener methods are called in sequence, but if you are fine with
* them being called out of order you are welcome to use multiple threads.
+ * </p>
*
* @param listener the listener to attach
* @param executor An executor to run the methods for the listener on.
@@ -293,7 +295,7 @@ public class LeaderLatch implements Closeable
* <p>Causes the current thread to wait until this instance acquires leadership
* unless the thread is {@linkplain Thread#interrupt interrupted} or {@linkplain #close() closed}.</p>
* <p>If this instance already is the leader then this method returns immediately.</p>
- * <p/>
+ * <p></p>
* <p>Otherwise the current
* thread becomes disabled for thread scheduling purposes and lies
* dormant until one of three things happen:</p>
@@ -335,10 +337,10 @@ public class LeaderLatch implements Closeable
* <p>Causes the current thread to wait until this instance acquires leadership
* unless the thread is {@linkplain Thread#interrupt interrupted},
* the specified waiting time elapses or the instance is {@linkplain #close() closed}.</p>
- * <p/>
+ * <p></p>
* <p>If this instance already is the leader then this method returns immediately
* with the value {@code true}.</p>
- * <p/>
+ * <p></p>
* <p>Otherwise the current
* thread becomes disabled for thread scheduling purposes and lies
* dormant until one of four things happen:</p>
@@ -349,7 +351,7 @@ public class LeaderLatch implements Closeable
* <li>The specified waiting time elapses.</li>
* <li>The instance is {@linkplain #close() closed}</li>
* </ul>
- * <p/>
+ * <p></p>
* <p>If the current thread:</p>
* <ul>
* <li>has its interrupted status set on entry to this method; or
@@ -357,7 +359,7 @@ public class LeaderLatch implements Closeable
* </ul>
* <p>then {@link InterruptedException} is thrown and the current thread's
* interrupted status is cleared.</p>
- * <p/>
+ * <p></p>
* <p>If the specified waiting time elapses or the instance is {@linkplain #close() closed}
* then the value {@code false} is returned. If the time is less than or equal to zero, the method
* will not wait at all.</p>