update javadocs

Author: ryber

unirest/src/main/java/kong/unirest/core/Config.java

@@ -883,6 +883,9 @@ public String getDefaultBaseUrl() {
         return this.defaultBaseUrl;
     }
 
+    /**
+     * @return the custom executor
+     */
     public Executor getCustomExecutor(){
         return customExecutor;
     }
@@ -918,6 +921,9 @@ public long getTTL() {
         }
     }
 
+    /**
+     * @return the RetryStrategy configured
+     */
     public RetryStrategy getRetryStrategy() {
         return retry;
     }

unirest/src/main/java/kong/unirest/core/Headers.java

@@ -31,6 +31,9 @@
 import static java.util.stream.Collectors.toList;
 import static java.util.stream.Collectors.toSet;
 
+/**
+ * Represents a collection of headers
+ */
 public class Headers {
 
     private static final long serialVersionUID = 71310341388734766L;
@@ -147,6 +150,22 @@ public List<Header> all() {
         return new ArrayList<>(this.headers);
     }
 
+    /**
+     * Add a Cookie header
+     * @param cookie the cookie
+     */
+    public void cookie(Cookie cookie) {
+        headers.add(new Entry("cookie", cookie.toString()));
+    }
+
+    /**
+     * sets a collection of cookies
+     * @param cookies some cookies
+     */
+    public void cookie(Collection<Cookie> cookies) {
+        cookies.forEach(this::cookie);
+    }
+
     private boolean isName(Header h, String name) {
         return Util.nullToEmpty(name).equalsIgnoreCase(h.getName());
     }
@@ -170,14 +189,6 @@ public String toString() {
         return sb.toString();
     }
 
-    public void cookie(Cookie cookie) {
-        headers.add(new Entry("cookie", cookie.toString()));
-    }
-
-    public void cookie(Collection<Cookie> cookies) {
-        cookies.forEach(this::cookie);
-    }
-
     @Override
     public boolean equals(Object o) {
         if (this == o) { return true;}
@@ -191,14 +202,30 @@ public int hashCode() {
         return Objects.hash(headers);
     }
 
+    /**
+     * creates a basic auth header from a username and password.
+     * The creds will be the Base64 encoded value of {username}:{password} along with the 'Basic' schema
+     * For example given a creds of "username" and "password" you would get
+     * eg: Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
+     * @param username the username
+     * @param password the password
+     */
     public void setBasicAuth(String username, String password) {
         this.replace("Authorization", Util.toBasicAuthValue(username, password));
     }
 
+    /**
+     * sets the Accept header
+     * @param value the value for accept
+     */
     public void accepts(String value) {
         add(HeaderNames.ACCEPT, value);
     }
 
+    /**
+     * Sets headers based on a map of key-value pairs
+     * @param headerMap I'm the MAP
+     */
     public void add(Map<String, String> headerMap) {
         if (headerMap != null) {
             for (Map.Entry<String, String> entry : headerMap.entrySet()) {

unirest/src/main/java/kong/unirest/core/Proxy.java

@@ -25,39 +25,72 @@
 
 package kong.unirest.core;
 
+/**
+ * represents basic proxy settings
+ * When this is used to configure the client it sets the following:
+ *    Proxy host and port are configured as a simple java.net.ProxySelector and set as the default selector
+ *    Username and password are configured as a single java.net.Authenticator which will apply to ALL auth challenges (not just the proxy)
+ */
 public class Proxy {
     private final String host;
     private final Integer port;
     private final String username;
     private final String password;
 
+    /**
+     * Construct just based on host and port
+     * @param host hostname
+     * @param port the port
+     */
     public Proxy(String host, Integer port){
         this(host, port, null, null);
     }
 
+    /**
+     * Construct with all the things
+     * @param host hostname
+     * @param port the port
+     * @param username username for authentication
+     * @param password password for authentication
+     */
     public Proxy(String host, Integer port, String username, String password) {
         this.host = host;
         this.port = port;
         this.username = username;
         this.password = password;
     }
 
+    /**
+     * @return the host
+     */
     public String getHost() {
         return host;
     }
 
+    /**
+     * @return the port
+     */
     public Integer getPort() {
         return port;
     }
 
+    /**
+     * @return the username for authentication
+     */
     public String getUsername() {
         return username;
     }
 
+    /**
+     * @return the password
+     */
     public String getPassword() {
         return password;
     }
 
+    /**
+     * @return indicates that the username and password have been configured.
+     */
     public boolean isAuthenticated() {
         return username != null && password != null;
     }

unirest/src/test/java/kong/unirest/core/UtilTest.java

@@ -32,6 +32,7 @@
 import java.time.ZonedDateTime;
 import java.util.Locale;
 
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 class UtilTest {
@@ -68,4 +69,10 @@ void parseLegacyFormat_whenChinese() {
         assertEquals(ZonedDateTime.of(2020,3,6, 16,5,35,0, ZoneId.of("GMT")),
                 Util.tryParseToDate("Fri, 06 Mar 2020 16:05:35 GMT"));
     }
+
+    @Test
+    void basicAuth() {
+        assertThat(Util.toBasicAuthValue("username", "password"))
+                .isEqualTo("Basic dXNlcm5hbWU6cGFzc3dvcmQ=");
+    }
 }