Improve NodeDistance javadoc

olim7t · olim7t · commit 0ba327287dd8 · 2017-08-04T17:37:27.000-07:00
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/metadata/DistanceEvent.java b/core/src/main/java/com/datastax/oss/driver/internal/core/metadata/DistanceEvent.java
@@ -16,9 +16,15 @@
 package com.datastax.oss.driver.internal.core.metadata;
 
 import com.datastax.oss.driver.api.core.loadbalancing.NodeDistance;
+import com.datastax.oss.driver.api.core.metadata.Node;
 import java.util.Objects;
 
-/** Fired when the load balancing policy assigns a new distance to a host. */
+/**
+ * Indicates that the load balancing policy has assigned a new distance to a host.
+ *
+ * <p>This is informational only: firing this event manually does <b>not</b> change the distance.
+ * For that, see {@link LoadBalancingPolicyWrapper#setDistance(Node, NodeDistance)}.
+ */
 public class DistanceEvent {
   public final NodeDistance distance;
   public final DefaultNode node;
