Fix javadoc on ComputeNodePersistService (#34249)

apache · Jan 4, 2025 · 0e9df36 · 0e9df36
1 parent 2305059
commit 0e9df36
Showing 1 changed file with 14 additions and 14 deletions.
diff --git a/...ava/org/apache/shardingsphere/mode/persist/service/unified/ComputeNodePersistService.java b/...ava/org/apache/shardingsphere/mode/persist/service/unified/ComputeNodePersistService.java
@@ -65,18 +65,18 @@ public void registerOnline(final ComputeNodeInstance computeNodeInstance) {
     /**
      * Persist instance labels.
      *
-     * @param instanceId instance id
+     * @param instanceId instance ID
      * @param labels instance labels
      */
     public void persistInstanceLabels(final String instanceId, final Collection<String> labels) {
         repository.persistEphemeral(ComputeNode.getInstanceLabelsNodePath(instanceId), YamlEngine.marshal(labels));
     }
 
     /**
-     * Persist instance worker id.
+     * Persist instance worker ID.
      *
-     * @param instanceId instance id
-     * @param workerId worker id
+     * @param instanceId instance ID
+     * @param workerId worker ID
      */
     public void persistInstanceWorkerId(final String instanceId, final int workerId) {
         repository.persistEphemeral(ComputeNode.getInstanceWorkerIdNodePath(instanceId), String.valueOf(workerId));
@@ -85,7 +85,7 @@ public void persistInstanceWorkerId(final String instanceId, final int workerId)
     /**
      * Load instance labels.
      *
-     * @param instanceId instance id
+     * @param instanceId instance ID
      * @return labels
      */
     @SuppressWarnings("unchecked")
@@ -97,18 +97,18 @@ public Collection<String> loadInstanceLabels(final String instanceId) {
     /**
      * Load compute node state.
      *
-     * @param instanceId instance id
+     * @param instanceId instance ID
      * @return state
      */
     public String loadComputeNodeState(final String instanceId) {
         return repository.query(ComputeNode.getComputeNodeStateNodePath(instanceId));
     }
 
     /**
-     * Load instance worker id.
+     * Load instance worker ID.
      *
-     * @param instanceId instance id
-     * @return worker id
+     * @param instanceId instance ID
+     * @return worker ID
      */
     public Optional<Integer> loadInstanceWorkerId(final String instanceId) {
         try {
@@ -143,9 +143,9 @@ private Collection<ComputeNodeInstance> loadComputeNodeInstances(final InstanceT
     }
 
     /**
-     * Load compute node instance by instance definition.
+     * Load compute node instance by instance meta data.
      *
-     * @param instanceMetaData instance definition
+     * @param instanceMetaData instance meta data
      * @return compute node instance
      */
     public ComputeNodeInstance loadComputeNodeInstance(final InstanceMetaData instanceMetaData) {
@@ -157,9 +157,9 @@ public ComputeNodeInstance loadComputeNodeInstance(final InstanceMetaData instan
     }
 
     /**
-     * Get assigned worker ids.
+     * Get assigned worker IDs.
      *
-     * @return assigned worker ids
+     * @return assigned worker IDs
      */
     public Collection<Integer> getAssignedWorkerIds() {
         Collection<String> childrenKeys = repository.getChildrenKeys(ComputeNode.getInstanceWorkerIdRootNodePath());
@@ -176,7 +176,7 @@ public Collection<Integer> getAssignedWorkerIds() {
     /**
      * Update compute node state.
      *
-     * @param instanceId instance id
+     * @param instanceId instance ID
      * @param instanceState instance state
      */
     public void updateComputeNodeState(final String instanceId, final InstanceState instanceState) {