Return-Path: X-Original-To: apmail-curator-commits-archive@minotaur.apache.org Delivered-To: apmail-curator-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id EFBE3176F7 for ; Thu, 2 Oct 2014 22:12:22 +0000 (UTC) Received: (qmail 66081 invoked by uid 500); 2 Oct 2014 22:12:22 -0000 Delivered-To: apmail-curator-commits-archive@curator.apache.org Received: (qmail 66049 invoked by uid 500); 2 Oct 2014 22:12:22 -0000 Mailing-List: contact commits-help@curator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@curator.apache.org Delivered-To: mailing list commits@curator.apache.org Received: (qmail 66040 invoked by uid 99); 2 Oct 2014 22:12:22 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 02 Oct 2014 22:12:22 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 8E3C1A1E054; Thu, 2 Oct 2014 22:12:22 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: dragonsinth@apache.org To: commits@curator.apache.org Message-Id: <446a7626647b4a37bde937b172790840@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: git commit: Fix broken javadoc Date: Thu, 2 Oct 2014 22:12:22 +0000 (UTC) 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 Authored: Thu Oct 2 18:12:16 2014 -0400 Committer: Scott Blum 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} - *

+ *

* 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. + *

*/ CONNECTION_SUSPENDED, /** * Called when the connection has changed to {@link org.apache.curator.framework.state.ConnectionState#RECONNECTED} - *

+ *

* 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. + *

*/ CONNECTION_RECONNECTED, /** * Called when the connection has changed to {@link org.apache.curator.framework.state.ConnectionState#LOST} - *

+ *

* 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. + *

*/ CONNECTION_LOST, /** * Posted after the initial cache has been fully populated. - *

+ *

* 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. - *

+ *

* 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. + *

*/ 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 - *

+ *

* Attaching the same listener multiple times is a noop from the second time on. - *

+ *

* 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. + *

* * @param listener the listener to attach */ @@ -264,12 +265,13 @@ public class LeaderLatch implements Closeable /** * Attaches a listener to this LeaderLatch - *

+ *

* Attaching the same listener multiple times is a noop from the second time on. - *

+ *

* 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. + *

* * @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 *

Causes the current thread to wait until this instance acquires leadership * unless the thread is {@linkplain Thread#interrupt interrupted} or {@linkplain #close() closed}.

*

If this instance already is the leader then this method returns immediately.

- *

+ *

*

Otherwise the current * thread becomes disabled for thread scheduling purposes and lies * dormant until one of three things happen:

@@ -335,10 +337,10 @@ public class LeaderLatch implements Closeable *

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}.

- *

+ *

*

If this instance already is the leader then this method returns immediately * with the value {@code true}.

- *

+ *

*

Otherwise the current * thread becomes disabled for thread scheduling purposes and lies * dormant until one of four things happen:

@@ -349,7 +351,7 @@ public class LeaderLatch implements Closeable *
  • The specified waiting time elapses.
    • *
  • The instance is {@linkplain #close() closed}
    • * - *

    + *

    *

    If the current thread:

    *
      *
    • has its interrupted status set on entry to this method; or @@ -357,7 +359,7 @@ public class LeaderLatch implements Closeable *
    *

    then {@link InterruptedException} is thrown and the current thread's * interrupted status is cleared.

    - *

    + *

    *

    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.