Author: tomekr
Date: Tue Jul 18 09:26:29 2017
New Revision: 1802259
URL: http://svn.apache.org/viewvc?rev=1802259&view=rev
Log:
@trivial - fixed javadoc formatting for oak-store-spi
Modified:
jackrabbit/oak/trunk/oak-store-spi/src/main/java/org/apache/jackrabbit/oak/spi/state/Clusterable.java
Modified:
jackrabbit/oak/trunk/oak-store-spi/src/main/java/org/apache/jackrabbit/oak/spi/state/Clusterable.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-store-spi/src/main/java/org/apache/jackrabbit/oak/spi/state/Clusterable.java?rev=1802259&r1=1802258&r2=1802259&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-store-spi/src/main/java/org/apache/jackrabbit/oak/spi/state/Clusterable.java
(original)
+++
jackrabbit/oak/trunk/oak-store-spi/src/main/java/org/apache/jackrabbit/oak/spi/state/Clusterable.java
Tue Jul 18 09:26:29 2017
@@ -35,40 +35,40 @@ public interface Clusterable {
String getInstanceId();
/**
- * Returns the visibility token of the underlying NodeStore. A 'visibility
+ * <p>Returns the visibility token of the underlying NodeStore. A
'visibility
* token' is an opaque String that can be used to verify if changes done on
* one NodeStore are visible on another NodeStore of the same cluster. This
* can be achieved by generating such a visibility token on the source
* NodeStore, passing it on to the target NodeStore (by whatever means) and
- * checking for visibility on that target NodeStore.
- * <p/>
- * The visibility check returns true if the target NodeStore sees at least
+ * checking for visibility on that target NodeStore.</p>
+ *
+ * <p>The visibility check returns true if the target NodeStore sees at
least
* all the changes that the source NodeStore saw at time of visibility
token
* generation. Once a visibility token is visible on a particular NodeStore
* it will always return true ever after. This also implies that the
* visibility check can only state whether at least all source changes are
* visible on the target and that it is independent of any further
- * modifications.
- * <p/>
- * When source and target NodeStore are identical, the visibility check is
+ * modifications.</p>
+ *
+ * <p>When source and target NodeStore are identical, the visibility check
is
* expected to return true, immediately. This is based on the assumption
* that with a session.refresh() on that NodeStore you'll always get the
- * latest changes applied by any other session locally.
- * <p/>
- * Visibility tokens are meant to be lightweight and are not expected to be
+ * latest changes applied by any other session locally.</p>
+ *
+ * <p>Visibility tokens are meant to be lightweight and are not expected
to be
* persisted by the implementor. Nevertheless they should survive their
- * validity in the case of crashes of the source and/or the target
instance.
+ * validity in the case of crashes of the source and/or the target
instance.</p>
*/
@Nullable
String getVisibilityToken();
/**
- * Checks if the underlying NodeStore sees at least the changes that were
+ * <p>Checks if the underlying NodeStore sees at least the changes that
were
* visible at the time the visibility token was created on potentially
- * another instance if in a clustered NodeStore setup.
- * <p/>
- * If the visibility token was created on the underlying NodeStore this
- * check always returns true, immediately.
+ * another instance if in a clustered NodeStore setup.</p>
+ *
+ * <p>If the visibility token was created on the underlying NodeStore this
+ * check always returns true, immediately.</p>
*
* @param visibilityToken
* the visibility token that was created on another instance in
a
@@ -83,8 +83,6 @@ public interface Clusterable {
* were visible at the time the visibility token was created
* @throws InterruptedException
* (optionally) thrown if interrupted while waiting
- * @see VisibilityTokenProvider VisibilityTokenProvider for a definition
and
- * usage of visibility tokens
*/
boolean isVisible(@Nonnull String visibilityToken, long maxWaitMillis)
throws InterruptedException;
}
\ No newline at end of file
