Add more explanation to JavaDoc for FindProxyDirective#proxyAddress

mablhq · Sep 11, 2023 · e2b5b57 · e2b5b57
1 parent 6de38eb
commit e2b5b57
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/main/java/com/mabl/net/proxy/FindProxyDirective.java b/src/main/java/com/mabl/net/proxy/FindProxyDirective.java
@@ -69,6 +69,13 @@ public boolean isProxy() {
 
     /**
      * Get the proxy address associated with this directive.
+     * <p>
+     * Note that the {@link InetSocketAddress} returned by this method is created via
+     * {@link InetSocketAddress#createUnresolved(String, int)}.  It may be necessary to create a new
+     * {@link InetSocketAddress} in order to resolve the hostname before use.
+     * <p>
+     * For example:
+     * <pre>new InetSocketAddress(address.getHostString(), address.getPort());</pre>
      *
      * @return the proxy address, or null if the connection type is {@link ConnectionType#DIRECT}.
      */