diff --git a/okhttp-logging-interceptor/pom.xml b/okhttp-logging-interceptor/pom.xml index dcb5375b4..b564f758b 100644 --- a/okhttp-logging-interceptor/pom.xml +++ b/okhttp-logging-interceptor/pom.xml @@ -18,6 +18,11 @@ okhttp ${project.version} + + com.google.code.findbugs + jsr305 + provided + junit diff --git a/okhttp-logging-interceptor/src/main/java/okhttp3/logging/package-info.java b/okhttp-logging-interceptor/src/main/java/okhttp3/logging/package-info.java new file mode 100644 index 000000000..39904701c --- /dev/null +++ b/okhttp-logging-interceptor/src/main/java/okhttp3/logging/package-info.java @@ -0,0 +1,3 @@ +/** An OkHttp interceptor which logs HTTP request and response data. */ +@javax.annotation.ParametersAreNonnullByDefault +package okhttp3.logging; diff --git a/okhttp/pom.xml b/okhttp/pom.xml index d393af077..f9dfc6ef7 100644 --- a/okhttp/pom.xml +++ b/okhttp/pom.xml @@ -22,6 +22,11 @@ android provided + + com.google.code.findbugs + jsr305 + provided + diff --git a/okhttp/src/main/java/okhttp3/Address.java b/okhttp/src/main/java/okhttp3/Address.java index 26828f16f..9df666ad7 100644 --- a/okhttp/src/main/java/okhttp3/Address.java +++ b/okhttp/src/main/java/okhttp3/Address.java @@ -18,6 +18,7 @@ package okhttp3; import java.net.Proxy; import java.net.ProxySelector; import java.util.List; +import javax.annotation.Nullable; import javax.net.SocketFactory; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLSocketFactory; @@ -42,15 +43,16 @@ public final class Address { final List protocols; final List connectionSpecs; final ProxySelector proxySelector; - final Proxy proxy; - final SSLSocketFactory sslSocketFactory; - final HostnameVerifier hostnameVerifier; - final CertificatePinner certificatePinner; + final @Nullable Proxy proxy; + final @Nullable SSLSocketFactory sslSocketFactory; + final @Nullable HostnameVerifier hostnameVerifier; + final @Nullable CertificatePinner certificatePinner; public Address(String uriHost, int uriPort, Dns dns, SocketFactory socketFactory, - SSLSocketFactory sslSocketFactory, HostnameVerifier hostnameVerifier, - CertificatePinner certificatePinner, Authenticator proxyAuthenticator, Proxy proxy, - List protocols, List connectionSpecs, ProxySelector proxySelector) { + @Nullable SSLSocketFactory sslSocketFactory, @Nullable HostnameVerifier hostnameVerifier, + @Nullable CertificatePinner certificatePinner, Authenticator proxyAuthenticator, + @Nullable Proxy proxy, List protocols, List connectionSpecs, + ProxySelector proxySelector) { this.url = new HttpUrl.Builder() .scheme(sslSocketFactory != null ? "https" : "http") .host(uriHost) @@ -130,26 +132,26 @@ public final class Address { * Returns this address's explicitly-specified HTTP proxy, or null to delegate to the {@linkplain * #proxySelector proxy selector}. */ - public Proxy proxy() { + public @Nullable Proxy proxy() { return proxy; } /** Returns the SSL socket factory, or null if this is not an HTTPS address. */ - public SSLSocketFactory sslSocketFactory() { + public @Nullable SSLSocketFactory sslSocketFactory() { return sslSocketFactory; } /** Returns the hostname verifier, or null if this is not an HTTPS address. */ - public HostnameVerifier hostnameVerifier() { + public @Nullable HostnameVerifier hostnameVerifier() { return hostnameVerifier; } /** Returns this address's certificate pinner, or null if this is not an HTTPS address. */ - public CertificatePinner certificatePinner() { + public @Nullable CertificatePinner certificatePinner() { return certificatePinner; } - @Override public boolean equals(Object other) { + @Override public boolean equals(@Nullable Object other) { return other instanceof Address && url.equals(((Address) other).url) && equalsNonHost((Address) other); diff --git a/okhttp/src/main/java/okhttp3/Authenticator.java b/okhttp/src/main/java/okhttp3/Authenticator.java index 6b0c4fe72..9e34bc970 100644 --- a/okhttp/src/main/java/okhttp3/Authenticator.java +++ b/okhttp/src/main/java/okhttp3/Authenticator.java @@ -16,6 +16,7 @@ package okhttp3; import java.io.IOException; +import javax.annotation.Nullable; /** * Responds to an authentication challenge from either a remote web server or a proxy server. @@ -70,5 +71,5 @@ public interface Authenticator { * Returns a request that includes a credential to satisfy an authentication challenge in {@code * response}. Returns null if the challenge cannot be satisfied. */ - Request authenticate(Route route, Response response) throws IOException; + @Nullable Request authenticate(Route route, Response response) throws IOException; } diff --git a/okhttp/src/main/java/okhttp3/Cache.java b/okhttp/src/main/java/okhttp3/Cache.java index a37bc916c..d43d91d25 100644 --- a/okhttp/src/main/java/okhttp3/Cache.java +++ b/okhttp/src/main/java/okhttp3/Cache.java @@ -28,6 +28,7 @@ import java.util.Collections; import java.util.Iterator; import java.util.List; import java.util.NoSuchElementException; +import javax.annotation.Nullable; import okhttp3.internal.Util; import okhttp3.internal.cache.CacheRequest; import okhttp3.internal.cache.CacheStrategy; @@ -186,7 +187,7 @@ public final class Cache implements Closeable, Flushable { return ByteString.encodeUtf8(url.toString()).md5().hex(); } - Response get(Request request) { + @Nullable Response get(Request request) { String key = key(request.url()); DiskLruCache.Snapshot snapshot; Entry entry; @@ -217,7 +218,7 @@ public final class Cache implements Closeable, Flushable { return response; } - CacheRequest put(Response response) { + @Nullable CacheRequest put(Response response) { String requestMethod = response.request().method(); if (HttpMethod.invalidatesCache(response.request().method())) { @@ -273,7 +274,7 @@ public final class Cache implements Closeable, Flushable { } } - private void abortQuietly(DiskLruCache.Editor editor) { + private void abortQuietly(@Nullable DiskLruCache.Editor editor) { // Give up because the cache cannot be written. try { if (editor != null) { @@ -327,7 +328,7 @@ public final class Cache implements Closeable, Flushable { return new Iterator() { final Iterator delegate = cache.snapshots(); - String nextUrl; + @Nullable String nextUrl; boolean canRemove; @Override public boolean hasNext() { @@ -484,7 +485,7 @@ public final class Cache implements Closeable, Flushable { private final int code; private final String message; private final Headers responseHeaders; - private final Handshake handshake; + private final @Nullable Handshake handshake; private final long sentRequestMillis; private final long receivedResponseMillis; @@ -732,8 +733,8 @@ public final class Cache implements Closeable, Flushable { private static class CacheResponseBody extends ResponseBody { final DiskLruCache.Snapshot snapshot; private final BufferedSource bodySource; - private final String contentType; - private final String contentLength; + private final @Nullable String contentType; + private final @Nullable String contentLength; CacheResponseBody(final DiskLruCache.Snapshot snapshot, String contentType, String contentLength) { diff --git a/okhttp/src/main/java/okhttp3/CacheControl.java b/okhttp/src/main/java/okhttp3/CacheControl.java index 39972c4bf..d128087c0 100644 --- a/okhttp/src/main/java/okhttp3/CacheControl.java +++ b/okhttp/src/main/java/okhttp3/CacheControl.java @@ -1,6 +1,7 @@ package okhttp3; import java.util.concurrent.TimeUnit; +import javax.annotation.Nullable; import okhttp3.internal.http.HttpHeaders; /** @@ -39,11 +40,12 @@ public final class CacheControl { private final boolean onlyIfCached; private final boolean noTransform; - String headerValue; // Lazily computed, null if absent. + @Nullable String headerValue; // Lazily computed, null if absent. private CacheControl(boolean noCache, boolean noStore, int maxAgeSeconds, int sMaxAgeSeconds, boolean isPrivate, boolean isPublic, boolean mustRevalidate, int maxStaleSeconds, - int minFreshSeconds, boolean onlyIfCached, boolean noTransform, String headerValue) { + int minFreshSeconds, boolean onlyIfCached, boolean noTransform, + @Nullable String headerValue) { this.noCache = noCache; this.noStore = noStore; this.maxAgeSeconds = maxAgeSeconds; diff --git a/okhttp/src/main/java/okhttp3/CertificatePinner.java b/okhttp/src/main/java/okhttp3/CertificatePinner.java index 722521a70..270737a26 100644 --- a/okhttp/src/main/java/okhttp3/CertificatePinner.java +++ b/okhttp/src/main/java/okhttp3/CertificatePinner.java @@ -23,6 +23,7 @@ import java.util.Collections; import java.util.LinkedHashSet; import java.util.List; import java.util.Set; +import javax.annotation.Nullable; import javax.net.ssl.SSLPeerUnverifiedException; import okhttp3.internal.tls.CertificateChainCleaner; import okio.ByteString; @@ -128,14 +129,14 @@ public final class CertificatePinner { public static final CertificatePinner DEFAULT = new Builder().build(); private final Set pins; - private final CertificateChainCleaner certificateChainCleaner; + private final @Nullable CertificateChainCleaner certificateChainCleaner; - CertificatePinner(Set pins, CertificateChainCleaner certificateChainCleaner) { + CertificatePinner(Set pins, @Nullable CertificateChainCleaner certificateChainCleaner) { this.pins = pins; this.certificateChainCleaner = certificateChainCleaner; } - @Override public boolean equals(Object other) { + @Override public boolean equals(@Nullable Object other) { if (other == this) return true; return other instanceof CertificatePinner && (equal(certificateChainCleaner, ((CertificatePinner) other).certificateChainCleaner) diff --git a/okhttp/src/main/java/okhttp3/Challenge.java b/okhttp/src/main/java/okhttp3/Challenge.java index f7c31b6f6..196de325b 100644 --- a/okhttp/src/main/java/okhttp3/Challenge.java +++ b/okhttp/src/main/java/okhttp3/Challenge.java @@ -15,6 +15,8 @@ */ package okhttp3; +import javax.annotation.Nullable; + /** An RFC 2617 challenge. */ public final class Challenge { private final String scheme; @@ -37,10 +39,10 @@ public final class Challenge { return realm; } - @Override public boolean equals(Object o) { - return o instanceof Challenge - && ((Challenge) o).scheme.equals(scheme) - && ((Challenge) o).realm.equals(realm); + @Override public boolean equals(@Nullable Object other) { + return other instanceof Challenge + && ((Challenge) other).scheme.equals(scheme) + && ((Challenge) other).realm.equals(realm); } @Override public int hashCode() { diff --git a/okhttp/src/main/java/okhttp3/Connection.java b/okhttp/src/main/java/okhttp3/Connection.java index d07e861d8..9fe9bbd88 100644 --- a/okhttp/src/main/java/okhttp3/Connection.java +++ b/okhttp/src/main/java/okhttp3/Connection.java @@ -17,6 +17,7 @@ package okhttp3; import java.net.Socket; +import javax.annotation.Nullable; /** * The sockets and streams of an HTTP, HTTPS, or HTTPS+HTTP/2 connection. May be used for multiple @@ -82,7 +83,7 @@ public interface Connection { * Returns the TLS handshake used to establish this connection, or null if the connection is not * HTTPS. */ - Handshake handshake(); + @Nullable Handshake handshake(); /** * Returns the protocol negotiated by this connection, or {@link Protocol#HTTP_1_1} if no protocol diff --git a/okhttp/src/main/java/okhttp3/ConnectionPool.java b/okhttp/src/main/java/okhttp3/ConnectionPool.java index a0128cfbc..6e305ab7b 100644 --- a/okhttp/src/main/java/okhttp3/ConnectionPool.java +++ b/okhttp/src/main/java/okhttp3/ConnectionPool.java @@ -27,6 +27,7 @@ import java.util.concurrent.Executor; import java.util.concurrent.SynchronousQueue; import java.util.concurrent.ThreadPoolExecutor; import java.util.concurrent.TimeUnit; +import javax.annotation.Nullable; import okhttp3.internal.Util; import okhttp3.internal.connection.RealConnection; import okhttp3.internal.connection.RouteDatabase; @@ -118,7 +119,7 @@ public final class ConnectionPool { * Returns a recycled connection to {@code address}, or null if no such connection exists. The * route is null if the address has not yet been routed. */ - RealConnection get(Address address, StreamAllocation streamAllocation, Route route) { + @Nullable RealConnection get(Address address, StreamAllocation streamAllocation, Route route) { assert (Thread.holdsLock(this)); for (RealConnection connection : connections) { if (connection.isEligible(address, route)) { @@ -133,7 +134,7 @@ public final class ConnectionPool { * Replaces the connection held by {@code streamAllocation} with a shared connection if possible. * This recovers when multiple multiplexed connections are created concurrently. */ - Socket deduplicate(Address address, StreamAllocation streamAllocation) { + @Nullable Socket deduplicate(Address address, StreamAllocation streamAllocation) { assert (Thread.holdsLock(this)); for (RealConnection connection : connections) { if (connection.isEligible(address, null) diff --git a/okhttp/src/main/java/okhttp3/ConnectionSpec.java b/okhttp/src/main/java/okhttp3/ConnectionSpec.java index 71f986749..25b9ee328 100644 --- a/okhttp/src/main/java/okhttp3/ConnectionSpec.java +++ b/okhttp/src/main/java/okhttp3/ConnectionSpec.java @@ -17,6 +17,7 @@ package okhttp3; import java.util.Arrays; import java.util.List; +import javax.annotation.Nullable; import javax.net.ssl.SSLSocket; import okhttp3.internal.Util; @@ -82,8 +83,8 @@ public final class ConnectionSpec { final boolean tls; final boolean supportsTlsExtensions; - final String[] cipherSuites; - final String[] tlsVersions; + final @Nullable String[] cipherSuites; + final @Nullable String[] tlsVersions; ConnectionSpec(Builder builder) { this.tls = builder.tls; @@ -97,18 +98,18 @@ public final class ConnectionSpec { } /** - * Returns the cipher suites to use for a connection. Returns {@code null} if all of the SSL - * socket's enabled cipher suites should be used. + * Returns the cipher suites to use for a connection. Returns null if all of the SSL socket's + * enabled cipher suites should be used. */ - public List cipherSuites() { + public @Nullable List cipherSuites() { return cipherSuites != null ? CipherSuite.forJavaNames(cipherSuites) : null; } /** - * Returns the TLS versions to use when negotiating a connection. Returns {@code null} if all of - * the SSL socket's enabled TLS versions should be used. + * Returns the TLS versions to use when negotiating a connection. Returns null if all of the SSL + * socket's enabled TLS versions should be used. */ - public List tlsVersions() { + public @Nullable List tlsVersions() { return tlsVersions != null ? TlsVersion.forJavaNames(tlsVersions) : null; } @@ -185,7 +186,7 @@ public final class ConnectionSpec { return true; } - @Override public boolean equals(Object other) { + @Override public boolean equals(@Nullable Object other) { if (!(other instanceof ConnectionSpec)) return false; if (other == this) return true; @@ -227,8 +228,8 @@ public final class ConnectionSpec { public static final class Builder { boolean tls; - String[] cipherSuites; - String[] tlsVersions; + @Nullable String[] cipherSuites; + @Nullable String[] tlsVersions; boolean supportsTlsExtensions; Builder(boolean tls) { diff --git a/okhttp/src/main/java/okhttp3/Cookie.java b/okhttp/src/main/java/okhttp3/Cookie.java index 296d74389..a20cac407 100644 --- a/okhttp/src/main/java/okhttp3/Cookie.java +++ b/okhttp/src/main/java/okhttp3/Cookie.java @@ -24,6 +24,7 @@ import java.util.List; import java.util.Locale; import java.util.regex.Matcher; import java.util.regex.Pattern; +import javax.annotation.Nullable; import okhttp3.internal.Util; import okhttp3.internal.http.HttpDate; import okhttp3.internal.publicsuffix.PublicSuffixDatabase; @@ -214,11 +215,11 @@ public final class Cookie { * Attempt to parse a {@code Set-Cookie} HTTP header value {@code setCookie} as a cookie. Returns * null if {@code setCookie} is not a well-formed cookie. */ - public static Cookie parse(HttpUrl url, String setCookie) { + public static @Nullable Cookie parse(HttpUrl url, String setCookie) { return parse(System.currentTimeMillis(), url, setCookie); } - static Cookie parse(long currentTimeMillis, HttpUrl url, String setCookie) { + static @Nullable Cookie parse(long currentTimeMillis, HttpUrl url, String setCookie) { int pos = 0; int limit = setCookie.length(); int cookiePairEnd = delimiterOffset(setCookie, pos, limit, ';'); @@ -581,7 +582,7 @@ public final class Cookie { return result.toString(); } - @Override public boolean equals(Object other) { + @Override public boolean equals(@Nullable Object other) { if (!(other instanceof Cookie)) return false; Cookie that = (Cookie) other; return that.name.equals(name) diff --git a/okhttp/src/main/java/okhttp3/Dispatcher.java b/okhttp/src/main/java/okhttp3/Dispatcher.java index d6f90bb3a..43f5aa48e 100644 --- a/okhttp/src/main/java/okhttp3/Dispatcher.java +++ b/okhttp/src/main/java/okhttp3/Dispatcher.java @@ -25,6 +25,7 @@ import java.util.concurrent.ExecutorService; import java.util.concurrent.SynchronousQueue; import java.util.concurrent.ThreadPoolExecutor; import java.util.concurrent.TimeUnit; +import javax.annotation.Nullable; import okhttp3.RealCall.AsyncCall; import okhttp3.internal.Util; @@ -38,10 +39,10 @@ import okhttp3.internal.Util; public final class Dispatcher { private int maxRequests = 64; private int maxRequestsPerHost = 5; - private Runnable idleCallback; + private @Nullable Runnable idleCallback; /** Executes calls. Created lazily. */ - private ExecutorService executorService; + private @Nullable ExecutorService executorService; /** Ready async calls in the order they'll be run. */ private final Deque readyAsyncCalls = new ArrayDeque<>(); @@ -119,7 +120,7 @@ public final class Dispatcher { * means that if you are doing synchronous calls the network layer will not truly be idle until * every returned {@link Response} has been closed. */ - public synchronized void setIdleCallback(Runnable idleCallback) { + public synchronized void setIdleCallback(@Nullable Runnable idleCallback) { this.idleCallback = idleCallback; } diff --git a/okhttp/src/main/java/okhttp3/FormBody.java b/okhttp/src/main/java/okhttp3/FormBody.java index 87ebb49f8..1b8d51f07 100644 --- a/okhttp/src/main/java/okhttp3/FormBody.java +++ b/okhttp/src/main/java/okhttp3/FormBody.java @@ -18,6 +18,7 @@ package okhttp3; import java.io.IOException; import java.util.ArrayList; import java.util.List; +import javax.annotation.Nullable; import okhttp3.internal.Util; import okio.Buffer; import okio.BufferedSink; @@ -76,7 +77,7 @@ public final class FormBody extends RequestBody { * to awkward operations like measuring the encoded length of header strings, or the * length-in-digits of an encoded integer. */ - private long writeOrCountBytes(BufferedSink sink, boolean countBytes) { + private long writeOrCountBytes(@Nullable BufferedSink sink, boolean countBytes) { long byteCount = 0L; Buffer buffer; diff --git a/okhttp/src/main/java/okhttp3/Handshake.java b/okhttp/src/main/java/okhttp3/Handshake.java index f1c49bd77..59a5418b8 100644 --- a/okhttp/src/main/java/okhttp3/Handshake.java +++ b/okhttp/src/main/java/okhttp3/Handshake.java @@ -20,6 +20,7 @@ import java.security.cert.Certificate; import java.security.cert.X509Certificate; import java.util.Collections; import java.util.List; +import javax.annotation.Nullable; import javax.net.ssl.SSLPeerUnverifiedException; import javax.net.ssl.SSLSession; import okhttp3.internal.Util; @@ -99,7 +100,7 @@ public final class Handshake { } /** Returns the remote peer's principle, or null if that peer is anonymous. */ - public Principal peerPrincipal() { + public @Nullable Principal peerPrincipal() { return !peerCertificates.isEmpty() ? ((X509Certificate) peerCertificates.get(0)).getSubjectX500Principal() : null; @@ -111,13 +112,13 @@ public final class Handshake { } /** Returns the local principle, or null if this peer is anonymous. */ - public Principal localPrincipal() { + public @Nullable Principal localPrincipal() { return !localCertificates.isEmpty() ? ((X509Certificate) localCertificates.get(0)).getSubjectX500Principal() : null; } - @Override public boolean equals(Object other) { + @Override public boolean equals(@Nullable Object other) { if (!(other instanceof Handshake)) return false; Handshake that = (Handshake) other; return tlsVersion.equals(that.tlsVersion) diff --git a/okhttp/src/main/java/okhttp3/Headers.java b/okhttp/src/main/java/okhttp3/Headers.java index efc5341fa..18342c2f0 100644 --- a/okhttp/src/main/java/okhttp3/Headers.java +++ b/okhttp/src/main/java/okhttp3/Headers.java @@ -27,6 +27,7 @@ import java.util.Map; import java.util.Set; import java.util.TreeMap; import java.util.TreeSet; +import javax.annotation.Nullable; import okhttp3.internal.Util; import okhttp3.internal.http.HttpDate; @@ -58,7 +59,7 @@ public final class Headers { } /** Returns the last value corresponding to the specified field, or null. */ - public String get(String name) { + public @Nullable String get(String name) { return get(namesAndValues, name); } @@ -66,7 +67,7 @@ public final class Headers { * Returns the last value corresponding to the specified field parsed as an HTTP date, or null if * either the field is absent or cannot be parsed as a date. */ - public Date getDate(String name) { + public @Nullable Date getDate(String name) { String value = get(name); return value != null ? HttpDate.parse(value) : null; } @@ -141,7 +142,7 @@ public final class Headers { * Applications that require semantically equal headers should convert them into a canonical form * before comparing them for equality. */ - @Override public boolean equals(Object other) { + @Override public boolean equals(@Nullable Object other) { return other instanceof Headers && Arrays.equals(((Headers) other).namesAndValues, namesAndValues); } diff --git a/okhttp/src/main/java/okhttp3/HttpUrl.java b/okhttp/src/main/java/okhttp3/HttpUrl.java index 2ccfb5f0d..555c4bd1e 100644 --- a/okhttp/src/main/java/okhttp3/HttpUrl.java +++ b/okhttp/src/main/java/okhttp3/HttpUrl.java @@ -27,6 +27,7 @@ import java.util.Collections; import java.util.LinkedHashSet; import java.util.List; import java.util.Set; +import javax.annotation.Nullable; import okhttp3.internal.publicsuffix.PublicSuffixDatabase; import okio.Buffer; @@ -324,10 +325,10 @@ public final class HttpUrl { * non-empty, but never null. Values are null if the name has no corresponding '=' separator, or * empty, or non-empty. */ - private final List queryNamesAndValues; + private final @Nullable List queryNamesAndValues; /** Decoded fragment. */ - private final String fragment; + private final @Nullable String fragment; /** Canonical URL. */ private final String url; @@ -606,7 +607,7 @@ public final class HttpUrl { * {@code http://host/?a=apple&b}{@code "a=apple&b"} * */ - public String encodedQuery() { + public @Nullable String encodedQuery() { if (queryNamesAndValues == null) return null; // No query. int queryStart = url.indexOf('?') + 1; int queryEnd = delimiterOffset(url, queryStart + 1, url.length(), '#'); @@ -666,7 +667,7 @@ public final class HttpUrl { * {@code http://host/?a=apple&b}{@code "a=apple&b"} * */ - public String query() { + public @Nullable String query() { if (queryNamesAndValues == null) return null; // No query. StringBuilder result = new StringBuilder(); namesAndValuesToQueryString(result, queryNamesAndValues); @@ -704,7 +705,7 @@ public final class HttpUrl { * {@code http://host/?a=apple&b}{@code "apple"} * */ - public String queryParameter(String name) { + public @Nullable String queryParameter(String name) { if (queryNamesAndValues == null) return null; for (int i = 0, size = queryNamesAndValues.size(); i < size; i += 2) { if (name.equals(queryNamesAndValues.get(i))) { @@ -821,7 +822,7 @@ public final class HttpUrl { * {@code http://host/#abc|def}{@code "abc|def"} * */ - public String encodedFragment() { + public @Nullable String encodedFragment() { if (fragment == null) return null; int fragmentStart = url.indexOf('#') + 1; return url.substring(fragmentStart); @@ -839,7 +840,7 @@ public final class HttpUrl { * {@code http://host/#abc|def}{@code "abc|def"} * */ - public String fragment() { + public @Nullable String fragment() { return fragment; } @@ -860,7 +861,7 @@ public final class HttpUrl { * Returns the URL that would be retrieved by following {@code link} from this URL, or null if * the resulting URL is not well-formed. */ - public HttpUrl resolve(String link) { + public @Nullable HttpUrl resolve(String link) { Builder builder = newBuilder(link); return builder != null ? builder.build() : null; } @@ -884,7 +885,7 @@ public final class HttpUrl { * Returns a builder for the URL that would be retrieved by following {@code link} from this URL, * or null if the resulting URL is not well-formed. */ - public Builder newBuilder(String link) { + public @Nullable Builder newBuilder(String link) { Builder builder = new Builder(); Builder.ParseResult result = builder.parse(this, link); return result == Builder.ParseResult.SUCCESS ? builder : null; @@ -894,7 +895,7 @@ public final class HttpUrl { * Returns a new {@code HttpUrl} representing {@code url} if it is a well-formed HTTP or HTTPS * URL, or null if it isn't. */ - public static HttpUrl parse(String url) { + public static @Nullable HttpUrl parse(String url) { Builder builder = new Builder(); Builder.ParseResult result = builder.parse(null, url); return result == Builder.ParseResult.SUCCESS ? builder.build() : null; @@ -904,7 +905,7 @@ public final class HttpUrl { * Returns an {@link HttpUrl} for {@code url} if its protocol is {@code http} or {@code https}, or * null if it has any other protocol. */ - public static HttpUrl get(URL url) { + public static @Nullable HttpUrl get(URL url) { return parse(url.toString()); } @@ -931,12 +932,12 @@ public final class HttpUrl { } } - public static HttpUrl get(URI uri) { + public static @Nullable HttpUrl get(URI uri) { return parse(uri.toString()); } - @Override public boolean equals(Object o) { - return o instanceof HttpUrl && ((HttpUrl) o).url.equals(url); + @Override public boolean equals(@Nullable Object other) { + return other instanceof HttpUrl && ((HttpUrl) other).url.equals(url); } @Override public int hashCode() { @@ -966,20 +967,20 @@ public final class HttpUrl { * {@code http://127.0.0.1}null * */ - public String topPrivateDomain() { + public @Nullable String topPrivateDomain() { if (verifyAsIpAddress(host)) return null; return PublicSuffixDatabase.get().getEffectiveTldPlusOne(host); } public static final class Builder { - String scheme; + @Nullable String scheme; String encodedUsername = ""; String encodedPassword = ""; - String host; + @Nullable String host; int port = -1; final List encodedPathSegments = new ArrayList<>(); - List encodedQueryNamesAndValues; - String encodedFragment; + @Nullable List encodedQueryNamesAndValues; + @Nullable String encodedFragment; public Builder() { encodedPathSegments.add(""); // The default path is '/' which needs a trailing space. @@ -1133,7 +1134,7 @@ public final class HttpUrl { return this; } - public Builder query(String query) { + public Builder query(@Nullable String query) { this.encodedQueryNamesAndValues = query != null ? queryStringToNamesAndValues(canonicalize( query, QUERY_ENCODE_SET, false, false, true, true)) @@ -1141,7 +1142,7 @@ public final class HttpUrl { return this; } - public Builder encodedQuery(String encodedQuery) { + public Builder encodedQuery(@Nullable String encodedQuery) { this.encodedQueryNamesAndValues = encodedQuery != null ? queryStringToNamesAndValues( canonicalize(encodedQuery, QUERY_ENCODE_SET, true, false, true, true)) @@ -1150,7 +1151,7 @@ public final class HttpUrl { } /** Encodes the query parameter using UTF-8 and adds it to this URL's query string. */ - public Builder addQueryParameter(String name, String value) { + public Builder addQueryParameter(String name, @Nullable String value) { if (name == null) throw new NullPointerException("name == null"); if (encodedQueryNamesAndValues == null) encodedQueryNamesAndValues = new ArrayList<>(); encodedQueryNamesAndValues.add( @@ -1162,7 +1163,7 @@ public final class HttpUrl { } /** Adds the pre-encoded query parameter to this URL's query string. */ - public Builder addEncodedQueryParameter(String encodedName, String encodedValue) { + public Builder addEncodedQueryParameter(String encodedName, @Nullable String encodedValue) { if (encodedName == null) throw new NullPointerException("encodedName == null"); if (encodedQueryNamesAndValues == null) encodedQueryNamesAndValues = new ArrayList<>(); encodedQueryNamesAndValues.add( @@ -1173,13 +1174,13 @@ public final class HttpUrl { return this; } - public Builder setQueryParameter(String name, String value) { + public Builder setQueryParameter(String name, @Nullable String value) { removeAllQueryParameters(name); addQueryParameter(name, value); return this; } - public Builder setEncodedQueryParameter(String encodedName, String encodedValue) { + public Builder setEncodedQueryParameter(String encodedName, @Nullable String encodedValue) { removeAllEncodedQueryParameters(encodedName); addEncodedQueryParameter(encodedName, encodedValue); return this; @@ -1215,14 +1216,14 @@ public final class HttpUrl { } } - public Builder fragment(String fragment) { + public Builder fragment(@Nullable String fragment) { this.encodedFragment = fragment != null ? canonicalize(fragment, FRAGMENT_ENCODE_SET, false, false, false, false) : null; return this; } - public Builder encodedFragment(String encodedFragment) { + public Builder encodedFragment(@Nullable String encodedFragment) { this.encodedFragment = encodedFragment != null ? canonicalize(encodedFragment, FRAGMENT_ENCODE_SET, true, false, false, false) : null; @@ -1313,7 +1314,7 @@ public final class HttpUrl { INVALID_HOST, } - ParseResult parse(HttpUrl base, String input) { + ParseResult parse(@Nullable HttpUrl base, String input) { int pos = skipLeadingAsciiWhitespace(input, 0, input.length()); int limit = skipTrailingAsciiWhitespace(input, pos, input.length()); @@ -1598,7 +1599,7 @@ public final class HttpUrl { } /** Decodes an IPv6 address like 1111:2222:3333:4444:5555:6666:7777:8888 or ::1. */ - private static InetAddress decodeIpv6(String input, int pos, int limit) { + private static @Nullable InetAddress decodeIpv6(String input, int pos, int limit) { byte[] address = new byte[16]; int b = 0; int compress = -1; diff --git a/okhttp/src/main/java/okhttp3/Interceptor.java b/okhttp/src/main/java/okhttp3/Interceptor.java index c1f8840a3..71e133e09 100644 --- a/okhttp/src/main/java/okhttp3/Interceptor.java +++ b/okhttp/src/main/java/okhttp3/Interceptor.java @@ -16,6 +16,7 @@ package okhttp3; import java.io.IOException; +import javax.annotation.Nullable; /** * Observes, modifies, and potentially short-circuits requests going out and the corresponding @@ -30,6 +31,10 @@ public interface Interceptor { Response proceed(Request request) throws IOException; - Connection connection(); + /** + * Returns the connection the request will be executed on. This is only available in the chains + * of network interceptors; for application interceptors this is always null. + */ + @Nullable Connection connection(); } } diff --git a/okhttp/src/main/java/okhttp3/MediaType.java b/okhttp/src/main/java/okhttp3/MediaType.java index d171f06c1..95194c571 100644 --- a/okhttp/src/main/java/okhttp3/MediaType.java +++ b/okhttp/src/main/java/okhttp3/MediaType.java @@ -19,6 +19,7 @@ import java.nio.charset.Charset; import java.util.Locale; import java.util.regex.Matcher; import java.util.regex.Pattern; +import javax.annotation.Nullable; /** * An RFC 2045 Media Type, appropriate to describe @@ -34,9 +35,9 @@ public final class MediaType { private final String mediaType; private final String type; private final String subtype; - private final String charset; + private final @Nullable String charset; - private MediaType(String mediaType, String type, String subtype, String charset) { + private MediaType(String mediaType, String type, String subtype, @Nullable String charset) { this.mediaType = mediaType; this.type = type; this.subtype = subtype; @@ -47,7 +48,7 @@ public final class MediaType { * Returns a media type for {@code string}, or null if {@code string} is not a well-formed media * type. */ - public static MediaType parse(String string) { + public static @Nullable MediaType parse(String string) { Matcher typeSubtype = TYPE_SUBTYPE.matcher(string); if (!typeSubtype.lookingAt()) return null; String type = typeSubtype.group(1).toLowerCase(Locale.US); @@ -99,7 +100,7 @@ public final class MediaType { /** * Returns the charset of this media type, or null if this media type doesn't specify a charset. */ - public Charset charset() { + public @Nullable Charset charset() { return charset(null); } @@ -107,7 +108,7 @@ public final class MediaType { * Returns the charset of this media type, or {@code defaultValue} if either this media type * doesn't specify a charset, of it its charset is unsupported by the current runtime. */ - public Charset charset(Charset defaultValue) { + public @Nullable Charset charset(@Nullable Charset defaultValue) { try { return charset != null ? Charset.forName(charset) : defaultValue; } catch (IllegalArgumentException e) { @@ -123,8 +124,8 @@ public final class MediaType { return mediaType; } - @Override public boolean equals(Object o) { - return o instanceof MediaType && ((MediaType) o).mediaType.equals(mediaType); + @Override public boolean equals(@Nullable Object other) { + return other instanceof MediaType && ((MediaType) other).mediaType.equals(mediaType); } @Override public int hashCode() { diff --git a/okhttp/src/main/java/okhttp3/MultipartBody.java b/okhttp/src/main/java/okhttp3/MultipartBody.java index 3aa31f310..09c1eaf2f 100644 --- a/okhttp/src/main/java/okhttp3/MultipartBody.java +++ b/okhttp/src/main/java/okhttp3/MultipartBody.java @@ -19,6 +19,7 @@ import java.io.IOException; import java.util.ArrayList; import java.util.List; import java.util.UUID; +import javax.annotation.Nullable; import okhttp3.internal.Util; import okio.Buffer; import okio.BufferedSink; @@ -119,7 +120,8 @@ public final class MultipartBody extends RequestBody { * to awkward operations like measuring the encoded length of header strings, or the * length-in-digits of an encoded integer. */ - private long writeOrCountBytes(BufferedSink sink, boolean countBytes) throws IOException { + private long writeOrCountBytes( + @Nullable BufferedSink sink, boolean countBytes) throws IOException { long byteCount = 0L; Buffer byteCountBuffer = null; @@ -225,7 +227,7 @@ public final class MultipartBody extends RequestBody { return create(null, body); } - public static Part create(Headers headers, RequestBody body) { + public static Part create(@Nullable Headers headers, RequestBody body) { if (body == null) { throw new NullPointerException("body == null"); } @@ -242,7 +244,7 @@ public final class MultipartBody extends RequestBody { return createFormData(name, null, RequestBody.create(null, value)); } - public static Part createFormData(String name, String filename, RequestBody body) { + public static Part createFormData(String name, @Nullable String filename, RequestBody body) { if (name == null) { throw new NullPointerException("name == null"); } @@ -257,15 +259,15 @@ public final class MultipartBody extends RequestBody { return create(Headers.of("Content-Disposition", disposition.toString()), body); } - final Headers headers; + final @Nullable Headers headers; final RequestBody body; - private Part(Headers headers, RequestBody body) { + private Part(@Nullable Headers headers, RequestBody body) { this.headers = headers; this.body = body; } - public Headers headers() { + public @Nullable Headers headers() { return headers; } @@ -308,7 +310,7 @@ public final class MultipartBody extends RequestBody { } /** Add a part to the body. */ - public Builder addPart(Headers headers, RequestBody body) { + public Builder addPart(@Nullable Headers headers, RequestBody body) { return addPart(Part.create(headers, body)); } @@ -318,7 +320,7 @@ public final class MultipartBody extends RequestBody { } /** Add a form data part to the body. */ - public Builder addFormDataPart(String name, String filename, RequestBody body) { + public Builder addFormDataPart(String name, @Nullable String filename, RequestBody body) { return addPart(Part.createFormData(name, filename, body)); } diff --git a/okhttp/src/main/java/okhttp3/OkHttpClient.java b/okhttp/src/main/java/okhttp3/OkHttpClient.java index ab4277544..6a11e8451 100644 --- a/okhttp/src/main/java/okhttp3/OkHttpClient.java +++ b/okhttp/src/main/java/okhttp3/OkHttpClient.java @@ -29,6 +29,7 @@ import java.util.List; import java.util.Random; import java.util.concurrent.ExecutorService; import java.util.concurrent.TimeUnit; +import javax.annotation.Nullable; import javax.net.SocketFactory; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; @@ -191,7 +192,7 @@ public class OkHttpClient implements Cloneable, Call.Factory, WebSocket.Factory } final Dispatcher dispatcher; - final Proxy proxy; + final @Nullable Proxy proxy; final List protocols; final List connectionSpecs; final List interceptors; @@ -199,11 +200,11 @@ public class OkHttpClient implements Cloneable, Call.Factory, WebSocket.Factory final EventListener.Factory eventListenerFactory; final ProxySelector proxySelector; final CookieJar cookieJar; - final Cache cache; - final InternalCache internalCache; + final @Nullable Cache cache; + final @Nullable InternalCache internalCache; final SocketFactory socketFactory; - final SSLSocketFactory sslSocketFactory; - final CertificateChainCleaner certificateChainCleaner; + final @Nullable SSLSocketFactory sslSocketFactory; + final @Nullable CertificateChainCleaner certificateChainCleaner; final HostnameVerifier hostnameVerifier; final CertificatePinner certificatePinner; final Authenticator proxyAuthenticator; @@ -433,7 +434,7 @@ public class OkHttpClient implements Cloneable, Call.Factory, WebSocket.Factory public static final class Builder { Dispatcher dispatcher; - Proxy proxy; + @Nullable Proxy proxy; List protocols; List connectionSpecs; final List interceptors = new ArrayList<>(); @@ -441,11 +442,11 @@ public class OkHttpClient implements Cloneable, Call.Factory, WebSocket.Factory EventListener.Factory eventListenerFactory; ProxySelector proxySelector; CookieJar cookieJar; - Cache cache; - InternalCache internalCache; + @Nullable Cache cache; + @Nullable InternalCache internalCache; SocketFactory socketFactory; - SSLSocketFactory sslSocketFactory; - CertificateChainCleaner certificateChainCleaner; + @Nullable SSLSocketFactory sslSocketFactory; + @Nullable CertificateChainCleaner certificateChainCleaner; HostnameVerifier hostnameVerifier; CertificatePinner certificatePinner; Authenticator proxyAuthenticator; @@ -568,7 +569,7 @@ public class OkHttpClient implements Cloneable, Call.Factory, WebSocket.Factory * precedence over {@link #proxySelector}, which is only honored when this proxy is null (which * it is by default). To disable proxy use completely, call {@code setProxy(Proxy.NO_PROXY)}. */ - public Builder proxy(Proxy proxy) { + public Builder proxy(@Nullable Proxy proxy) { this.proxy = proxy; return this; } @@ -599,13 +600,13 @@ public class OkHttpClient implements Cloneable, Call.Factory, WebSocket.Factory } /** Sets the response cache to be used to read and write cached responses. */ - void setInternalCache(InternalCache internalCache) { + void setInternalCache(@Nullable InternalCache internalCache) { this.internalCache = internalCache; this.cache = null; } /** Sets the response cache to be used to read and write cached responses. */ - public Builder cache(Cache cache) { + public Builder cache(@Nullable Cache cache) { this.cache = cache; this.internalCache = null; return this; diff --git a/okhttp/src/main/java/okhttp3/Request.java b/okhttp/src/main/java/okhttp3/Request.java index f4b0f6dba..cb8869626 100644 --- a/okhttp/src/main/java/okhttp3/Request.java +++ b/okhttp/src/main/java/okhttp3/Request.java @@ -17,6 +17,7 @@ package okhttp3; import java.net.URL; import java.util.List; +import javax.annotation.Nullable; import okhttp3.internal.Util; import okhttp3.internal.http.HttpMethod; @@ -28,7 +29,7 @@ public final class Request { final HttpUrl url; final String method; final Headers headers; - final RequestBody body; + final @Nullable RequestBody body; final Object tag; private volatile CacheControl cacheControl; // Lazily initialized. @@ -61,7 +62,7 @@ public final class Request { return headers.values(name); } - public RequestBody body() { + public @Nullable RequestBody body() { return body; } @@ -211,7 +212,7 @@ public final class Request { return method("POST", body); } - public Builder delete(RequestBody body) { + public Builder delete(@Nullable RequestBody body) { return method("DELETE", body); } @@ -227,7 +228,7 @@ public final class Request { return method("PATCH", body); } - public Builder method(String method, RequestBody body) { + public Builder method(String method, @Nullable RequestBody body) { if (method == null) throw new NullPointerException("method == null"); if (method.length() == 0) throw new IllegalArgumentException("method.length() == 0"); if (body != null && !HttpMethod.permitsRequestBody(method)) { diff --git a/okhttp/src/main/java/okhttp3/RequestBody.java b/okhttp/src/main/java/okhttp3/RequestBody.java index 136cfdc4e..11497b9f2 100644 --- a/okhttp/src/main/java/okhttp3/RequestBody.java +++ b/okhttp/src/main/java/okhttp3/RequestBody.java @@ -18,6 +18,7 @@ package okhttp3; import java.io.File; import java.io.IOException; import java.nio.charset.Charset; +import javax.annotation.Nullable; import okhttp3.internal.Util; import okio.BufferedSink; import okio.ByteString; @@ -26,7 +27,7 @@ import okio.Source; public abstract class RequestBody { /** Returns the Content-Type header for this body. */ - public abstract MediaType contentType(); + public abstract @Nullable MediaType contentType(); /** * Returns the number of bytes that will be written to {@code out} in a call to {@link #writeTo}, @@ -43,7 +44,7 @@ public abstract class RequestBody { * Returns a new request body that transmits {@code content}. If {@code contentType} is non-null * and lacks a charset, this will use UTF-8. */ - public static RequestBody create(MediaType contentType, String content) { + public static RequestBody create(@Nullable MediaType contentType, String content) { Charset charset = Util.UTF_8; if (contentType != null) { charset = contentType.charset(); @@ -57,9 +58,10 @@ public abstract class RequestBody { } /** Returns a new request body that transmits {@code content}. */ - public static RequestBody create(final MediaType contentType, final ByteString content) { + public static RequestBody create( + final @Nullable MediaType contentType, final ByteString content) { return new RequestBody() { - @Override public MediaType contentType() { + @Override public @Nullable MediaType contentType() { return contentType; } @@ -74,17 +76,17 @@ public abstract class RequestBody { } /** Returns a new request body that transmits {@code content}. */ - public static RequestBody create(final MediaType contentType, final byte[] content) { + public static RequestBody create(final @Nullable MediaType contentType, final byte[] content) { return create(contentType, content, 0, content.length); } /** Returns a new request body that transmits {@code content}. */ - public static RequestBody create(final MediaType contentType, final byte[] content, + public static RequestBody create(final @Nullable MediaType contentType, final byte[] content, final int offset, final int byteCount) { if (content == null) throw new NullPointerException("content == null"); Util.checkOffsetAndCount(content.length, offset, byteCount); return new RequestBody() { - @Override public MediaType contentType() { + @Override public @Nullable MediaType contentType() { return contentType; } @@ -99,11 +101,11 @@ public abstract class RequestBody { } /** Returns a new request body that transmits the content of {@code file}. */ - public static RequestBody create(final MediaType contentType, final File file) { + public static RequestBody create(final @Nullable MediaType contentType, final File file) { if (file == null) throw new NullPointerException("content == null"); return new RequestBody() { - @Override public MediaType contentType() { + @Override public @Nullable MediaType contentType() { return contentType; } diff --git a/okhttp/src/main/java/okhttp3/Response.java b/okhttp/src/main/java/okhttp3/Response.java index d534cbb2b..31475178a 100644 --- a/okhttp/src/main/java/okhttp3/Response.java +++ b/okhttp/src/main/java/okhttp3/Response.java @@ -19,6 +19,7 @@ import java.io.Closeable; import java.io.IOException; import java.util.Collections; import java.util.List; +import javax.annotation.Nullable; import okhttp3.internal.http.HttpHeaders; import okio.Buffer; import okio.BufferedSource; @@ -44,12 +45,12 @@ public final class Response implements Closeable { final Protocol protocol; final int code; final String message; - final Handshake handshake; + final @Nullable Handshake handshake; final Headers headers; - final ResponseBody body; - final Response networkResponse; - final Response cacheResponse; - final Response priorResponse; + final @Nullable ResponseBody body; + final @Nullable Response networkResponse; + final @Nullable Response cacheResponse; + final @Nullable Response priorResponse; final long sentRequestAtMillis; final long receivedResponseAtMillis; @@ -122,11 +123,11 @@ public final class Response implements Closeable { return headers.values(name); } - public String header(String name) { + public @Nullable String header(String name) { return header(name, null); } - public String header(String name, String defaultValue) { + public @Nullable String header(String name, @Nullable String defaultValue) { String result = headers.get(name); return result != null ? result : defaultValue; } @@ -172,7 +173,7 @@ public final class Response implements Closeable { *

This always returns null on responses returned from {@link #cacheResponse}, {@link * #networkResponse}, and {@link #priorResponse()}. */ - public ResponseBody body() { + public @Nullable ResponseBody body() { return body; } @@ -200,7 +201,7 @@ public final class Response implements Closeable { * the network, such as when the response is fully cached. The body of the returned response * should not be read. */ - public Response networkResponse() { + public @Nullable Response networkResponse() { return networkResponse; } @@ -209,7 +210,7 @@ public final class Response implements Closeable { * cache. For conditional get requests the cache response and network response may both be * non-null. The body of the returned response should not be read. */ - public Response cacheResponse() { + public @Nullable Response cacheResponse() { return cacheResponse; } @@ -219,7 +220,7 @@ public final class Response implements Closeable { * returned response should not be read because it has already been consumed by the redirecting * client. */ - public Response priorResponse() { + public @Nullable Response priorResponse() { return priorResponse; } @@ -290,7 +291,7 @@ public final class Response implements Closeable { Protocol protocol; int code = -1; String message; - Handshake handshake; + @Nullable Handshake handshake; Headers.Builder headers; ResponseBody body; Response networkResponse; @@ -338,7 +339,7 @@ public final class Response implements Closeable { return this; } - public Builder handshake(Handshake handshake) { + public Builder handshake(@Nullable Handshake handshake) { this.handshake = handshake; return this; } @@ -372,18 +373,18 @@ public final class Response implements Closeable { return this; } - public Builder body(ResponseBody body) { + public Builder body(@Nullable ResponseBody body) { this.body = body; return this; } - public Builder networkResponse(Response networkResponse) { + public Builder networkResponse(@Nullable Response networkResponse) { if (networkResponse != null) checkSupportResponse("networkResponse", networkResponse); this.networkResponse = networkResponse; return this; } - public Builder cacheResponse(Response cacheResponse) { + public Builder cacheResponse(@Nullable Response cacheResponse) { if (cacheResponse != null) checkSupportResponse("cacheResponse", cacheResponse); this.cacheResponse = cacheResponse; return this; @@ -401,7 +402,7 @@ public final class Response implements Closeable { } } - public Builder priorResponse(Response priorResponse) { + public Builder priorResponse(@Nullable Response priorResponse) { if (priorResponse != null) checkPriorResponse(priorResponse); this.priorResponse = priorResponse; return this; diff --git a/okhttp/src/main/java/okhttp3/ResponseBody.java b/okhttp/src/main/java/okhttp3/ResponseBody.java index c00e90f96..17447f3d6 100644 --- a/okhttp/src/main/java/okhttp3/ResponseBody.java +++ b/okhttp/src/main/java/okhttp3/ResponseBody.java @@ -21,6 +21,7 @@ import java.io.InputStream; import java.io.InputStreamReader; import java.io.Reader; import java.nio.charset.Charset; +import javax.annotation.Nullable; import okhttp3.internal.Util; import okio.Buffer; import okio.BufferedSource; @@ -102,7 +103,7 @@ public abstract class ResponseBody implements Closeable { /** Multiple calls to {@link #charStream()} must return the same instance. */ private Reader reader; - public abstract MediaType contentType(); + public abstract @Nullable MediaType contentType(); /** * Returns the number of bytes in that will returned by {@link #bytes}, or {@link #byteStream}, or @@ -190,7 +191,7 @@ public abstract class ResponseBody implements Closeable { * Returns a new response body that transmits {@code content}. If {@code contentType} is non-null * and lacks a charset, this will use UTF-8. */ - public static ResponseBody create(MediaType contentType, String content) { + public static ResponseBody create(@Nullable MediaType contentType, String content) { Charset charset = UTF_8; if (contentType != null) { charset = contentType.charset(); @@ -204,17 +205,17 @@ public abstract class ResponseBody implements Closeable { } /** Returns a new response body that transmits {@code content}. */ - public static ResponseBody create(final MediaType contentType, byte[] content) { + public static ResponseBody create(final @Nullable MediaType contentType, byte[] content) { Buffer buffer = new Buffer().write(content); return create(contentType, content.length, buffer); } /** Returns a new response body that transmits {@code content}. */ - public static ResponseBody create( - final MediaType contentType, final long contentLength, final BufferedSource content) { + public static ResponseBody create(final @Nullable MediaType contentType, + final long contentLength, final BufferedSource content) { if (content == null) throw new NullPointerException("source == null"); return new ResponseBody() { - @Override public MediaType contentType() { + @Override public @Nullable MediaType contentType() { return contentType; } diff --git a/okhttp/src/main/java/okhttp3/Route.java b/okhttp/src/main/java/okhttp3/Route.java index 7c7e9635e..14158673c 100644 --- a/okhttp/src/main/java/okhttp3/Route.java +++ b/okhttp/src/main/java/okhttp3/Route.java @@ -17,6 +17,7 @@ package okhttp3; import java.net.InetSocketAddress; import java.net.Proxy; +import javax.annotation.Nullable; /** * The concrete route used by a connection to reach an abstract origin server. When creating a @@ -79,14 +80,11 @@ public final class Route { return address.sslSocketFactory != null && proxy.type() == Proxy.Type.HTTP; } - @Override public boolean equals(Object obj) { - if (obj instanceof Route) { - Route other = (Route) obj; - return address.equals(other.address) - && proxy.equals(other.proxy) - && inetSocketAddress.equals(other.inetSocketAddress); - } - return false; + @Override public boolean equals(@Nullable Object other) { + return other instanceof Route + && ((Route) other).address.equals(address) + && ((Route) other).proxy.equals(proxy) + && ((Route) other).inetSocketAddress.equals(inetSocketAddress); } @Override public int hashCode() { diff --git a/okhttp/src/main/java/okhttp3/WebSocket.java b/okhttp/src/main/java/okhttp3/WebSocket.java index 12457e535..54cf6f402 100644 --- a/okhttp/src/main/java/okhttp3/WebSocket.java +++ b/okhttp/src/main/java/okhttp3/WebSocket.java @@ -15,6 +15,7 @@ */ package okhttp3; +import javax.annotation.Nullable; import okio.ByteString; /** @@ -101,7 +102,7 @@ public interface WebSocket { * href="http://tools.ietf.org/html/rfc6455#section-7.4">Section 7.4 of RFC 6455 or {@code 0}. * @param reason Reason for shutting down or {@code null}. */ - boolean close(int code, String reason); + boolean close(int code, @Nullable String reason); /** * Immediately and violently release resources held by this web socket, discarding any enqueued diff --git a/okhttp/src/main/java/okhttp3/internal/cache/CacheStrategy.java b/okhttp/src/main/java/okhttp3/internal/cache/CacheStrategy.java index dae556bb9..410e8acbc 100644 --- a/okhttp/src/main/java/okhttp3/internal/cache/CacheStrategy.java +++ b/okhttp/src/main/java/okhttp3/internal/cache/CacheStrategy.java @@ -16,6 +16,7 @@ package okhttp3.internal.cache; import java.util.Date; +import javax.annotation.Nullable; import okhttp3.CacheControl; import okhttp3.Headers; import okhttp3.Request; @@ -48,10 +49,10 @@ import static java.util.concurrent.TimeUnit.SECONDS; */ public final class CacheStrategy { /** The request to send on the network, or null if this call doesn't use the network. */ - public final Request networkRequest; + public final @Nullable Request networkRequest; /** The cached response to return or validate; or null if this call doesn't use a cache. */ - public final Response cacheResponse; + public final @Nullable Response cacheResponse; CacheStrategy(Request networkRequest, Response cacheResponse) { this.networkRequest = networkRequest; diff --git a/okhttp/src/main/java/okhttp3/internal/cache/DiskLruCache.java b/okhttp/src/main/java/okhttp3/internal/cache/DiskLruCache.java index 29a8ce0cf..c3fb740e2 100644 --- a/okhttp/src/main/java/okhttp3/internal/cache/DiskLruCache.java +++ b/okhttp/src/main/java/okhttp3/internal/cache/DiskLruCache.java @@ -32,6 +32,7 @@ import java.util.concurrent.ThreadPoolExecutor; import java.util.concurrent.TimeUnit; import java.util.regex.Matcher; import java.util.regex.Pattern; +import javax.annotation.Nullable; import okhttp3.internal.Util; import okhttp3.internal.io.FileSystem; import okhttp3.internal.platform.Platform; @@ -454,7 +455,7 @@ public final class DiskLruCache implements Closeable, Flushable { /** * Returns an editor for the entry named {@code key}, or null if another edit is in progress. */ - public Editor edit(String key) throws IOException { + public @Nullable Editor edit(String key) throws IOException { return edit(key, ANY_SEQUENCE_NUMBER); } @@ -805,7 +806,7 @@ public final class DiskLruCache implements Closeable, Flushable { * Returns an editor for this snapshot's entry, or null if either the entry has changed since * this snapshot was created or if another edit is in progress. */ - public Editor edit() throws IOException { + public @Nullable Editor edit() throws IOException { return DiskLruCache.this.edit(key, sequenceNumber); } diff --git a/okhttp/src/main/java/okhttp3/internal/connection/RealConnection.java b/okhttp/src/main/java/okhttp3/internal/connection/RealConnection.java index c6ee1ff8b..c5bc7d8b8 100644 --- a/okhttp/src/main/java/okhttp3/internal/connection/RealConnection.java +++ b/okhttp/src/main/java/okhttp3/internal/connection/RealConnection.java @@ -29,6 +29,7 @@ import java.security.cert.X509Certificate; import java.util.ArrayList; import java.util.List; import java.util.concurrent.TimeUnit; +import javax.annotation.Nullable; import javax.net.ssl.SSLPeerUnverifiedException; import javax.net.ssl.SSLSocket; import javax.net.ssl.SSLSocketFactory; @@ -378,7 +379,7 @@ public final class RealConnection extends Http2Connection.Listener implements Co * Returns true if this connection can carry a stream allocation to {@code address}. If non-null * {@code route} is the resolved route for a connection. */ - public boolean isEligible(Address address, Route route) { + public boolean isEligible(Address address, @Nullable Route route) { // If this connection is not accepting new streams, we're done. if (allocations.size() >= allocationLimit || noNewStreams) return false; diff --git a/okhttp/src/main/java/okhttp3/package-info.java b/okhttp/src/main/java/okhttp3/package-info.java new file mode 100644 index 000000000..a34c5bbf8 --- /dev/null +++ b/okhttp/src/main/java/okhttp3/package-info.java @@ -0,0 +1,3 @@ +/** An HTTP+HTTP/2 client for Android and Java applications. */ +@javax.annotation.ParametersAreNonnullByDefault +package okhttp3; diff --git a/pom.xml b/pom.xml index 5cf1c539b..dea1a09fd 100644 --- a/pom.xml +++ b/pom.xml @@ -87,6 +87,12 @@ okio ${okio.version} + + com.google.code.findbugs + jsr305 + 3.0.2 + provided + junit junit