io.apptik.comm.jus.Response Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jus-java Show documentation
Communication library for Android and Java
The newest version!
/*
 * Copyright (C) 2015 Apptik Project
 * Copyright (C) 2014 Kalin Maldzhanski
 * Copyright (C) 2011 The Android Open Source Project
 *
 * 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 io.apptik.comm.jus;

import io.apptik.comm.jus.error.JusError;

/**
 * Encapsulates a parsed response for delivery.
 *
 * @param  Parsed type of this response
 */
public class Response {

    /** Returns a successful response containing the parsed result. */
    public static  Response success(T result, Cache.Entry cacheEntry) {
        return new Response(result, cacheEntry);
    }

    /**
     * Returns a failed response containing the given error code and an optional
     * localized message displayed to the user.
     */
    public static  Response error(JusError error) {
        return new Response(error);
    }

    /** Parsed response, or null in the case of error. */
    public final T result;

    /** Cache metadata for this response, or null in the case of error. */
    public final Cache.Entry cacheEntry;

    /** Detailed error information if errorCode != OK. */
    public final JusError error;

    /** True if this response was a soft-expired one and a second one MAY be coming. */
    public boolean intermediate = false;

    /**
     * Returns whether this response is considered successful.
     */
    public boolean isSuccess() {
        return error == null;
    }


    Response(T result, Cache.Entry cacheEntry) {
        this.result = result;
        this.cacheEntry = cacheEntry;
        this.error = null;
    }

    private Response(JusError error) {
        this.result = null;
        this.cacheEntry = null;
        this.error = error;
    }

    @Override
    public String toString() {
        return "Response{" +
                "\n\tcacheEntry=" + cacheEntry +
                "\n\tresult=" + result +
                "\n\terror=" + error +
                "\n\tintermediate=" + intermediate +
                '}';
    }
}