com.uber.sdk.rides.client.error.ApiError Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016 Uber Technologies, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.uber.sdk.rides.client.error;

import java.util.Collections;
import java.util.List;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Represents an error response from the Uber API.
 */
public final class ApiError {

    @Nullable
    private final Meta meta;
    @Nonnull
    private final List errors;

    public ApiError(@Nullable Meta meta, @Nonnull List clientErrors) {
        this.meta = meta;
        this.errors = clientErrors;
    }

    ApiError(@Nonnull CompatibilityApiError oldApiError, int statusCode) {
        this(oldApiError.code, statusCode, oldApiError.message);
    }

    ApiError(@Nullable String code, int statusCode, @Nullable String message) {
        this(null, Collections.singletonList(new ClientError(code, statusCode, message)));
    }

    /**
     * @return the {@link Meta} information about the error.
     */
    @Nullable
    public Meta getMeta() {
        return meta;
    }

    /**
     * @return a list of {@link ClientError}s that occurred.
     */
    @Nonnull
    public List getClientErrors() {
        return errors;
    }
}