retrofit.Result Maven / Gradle / Ivy
/*
* Copyright (C) 2015 Square, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package retrofit;
import java.io.IOException;
import static retrofit.Utils.checkNotNull;
/** The result of executing an HTTP request. */
public final class Result {
public static Result error(Throwable error) {
return new Result<>(null, checkNotNull(error, "error == null"));
}
public static Result response(Response response) {
return new Result<>(checkNotNull(response, "response == null"), null);
}
private final Response response;
private final Throwable error;
Result(Response response, Throwable error) {
this.response = response;
this.error = error;
}
/**
* The response received from executing an HTTP request. Only present when {@link #isError()} is
* false, null otherwise.
*/
public Response response() {
return response;
}
/**
* The error experienced while attempting to execute an HTTP request. Only present when {@link
* #isError()} is true, null otherwise.
*
* If the error is an {@link IOException} then there was a problem with the transport to the
* remote server. Any other exception type indicates an unexpected failure and should be
* considered fatal (configuration error, programming error, etc.).
*/
public Throwable error() {
return error;
}
/** {@code true} if the request resulted in an error. See {@link #error()} for the cause. */
public boolean isError() {
return error != null;
}
}