This is an automated email from the ASF dual-hosted git repository.
blerer pushed a commit to branch cep-21-tcm-review
in repository https://gitbox.apache.org/repos/asf/cassandra.git
The following commit(s) were added to refs/heads/cep-21-tcm-review by this push:
new fbe391130a Fix ClusterMetadataService.state javadoc
fbe391130a is described below
commit fbe391130aa0946d7d8389e957e96520c6638842
Author: Benjamin Lerer <b.le...@gmail.com>
AuthorDate: Wed Oct 18 11:57:09 2023 +0200
Fix ClusterMetadataService.state javadoc
---
.../cassandra/tcm/ClusterMetadataService.java | 37 ++++++++++++++++++++--
1 file changed, 34 insertions(+), 3 deletions(-)
diff --git a/src/java/org/apache/cassandra/tcm/ClusterMetadataService.java
b/src/java/org/apache/cassandra/tcm/ClusterMetadataService.java
index d01c63b419..3b7afc273b 100644
--- a/src/java/org/apache/cassandra/tcm/ClusterMetadataService.java
+++ b/src/java/org/apache/cassandra/tcm/ClusterMetadataService.java
@@ -137,8 +137,15 @@ public class ClusterMetadataService
private final AtomicBoolean commitsPaused = new AtomicBoolean();
/**
- * Returns the state of the {@code ClusteMetadataService}.
- * @return the state of the {@code ClusteMetadataService}.
+ * Returns the current state of the {@code ClusteMetadataService}.
+ * <p>
+ * The state can be:
+ * <ul>
+ * <li>LOCAL: the node is a member of CMS</li>
+ * <li>REMOTE: the node is not a CMS nember</li>
+ * <li>GOSSIP: the node has not been upgraded to TCM yet</li>
+ * <li>RESET: the node is being forced to reset the local metadata</li>
+ * </ul>
*/
public static State state()
{
@@ -860,8 +867,32 @@ public class ClusterMetadataService
}
}
+ /**
+ * A state of the {@code ClusterMetadataService} of the node. A state can
be:
+ * <ul>
+ * <li>the node is a member of CMS</li>
+ * <li>the node is not a CMS nember</li>
+ * <li>the node has not been upgraded to TCM yet</li>
+ * <li>the node is being forced to reset the local metadata</li>
+ * </ul>
+ */
public enum State
{
- LOCAL, REMOTE, GOSSIP, RESET
+ /**
+ * The node is a member of the CMS
+ */
+ LOCAL,
+ /**
+ * The node is not a member of the CMS
+ */
+ REMOTE,
+ /**
+ * The node has not been upgraded to TCM yet
+ */
+ GOSSIP,
+ /**
+ * The node is being forced to reset the local metadata
+ */
+ RESET
}
}
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org
For additional commands, e-mail: commits-h...@cassandra.apache.org
