All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.apollographql.apollo.api.Error Maven / Gradle / Ivy

There is a newer version: 3.4.2
Show newest version
/**
 * Copyright 2018-2019 Amazon.com,
 * Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Amazon Software License (the "License").
 * You may not use this file except in compliance with the
 * License. A copy of the License is located at
 *
 *     http://aws.amazon.com/asl/
 *
 * or in the "license" file accompanying this file. This file is
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, express or implied. See the License
 * for the specific language governing permissions and
 * limitations under the License.
 */

package com.apollographql.apollo.api;

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

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

import static java.util.Collections.unmodifiableList;
import static java.util.Collections.unmodifiableMap;

/**
 * Represents an error response returned from the GraphQL server
 */
public final class Error {
  private final String message;
  private final List locations;
  private final Map customAttributes;

  public Error(@Nullable String message, @Nullable List locations,
      @Nullable Map customAttributes) {
    this.message = message;
    this.locations = locations != null ? unmodifiableList(locations) : Collections.emptyList();
    this.customAttributes = customAttributes != null ? unmodifiableMap(customAttributes)
        : Collections.emptyMap();
  }

  /**
   * Returns server error message.
   */
  @Nullable public String message() {
    return message;
  }

  /**
   * Returns the location of the error in the GraphQL operation.
   */
  @Nonnull public List locations() {
    return locations;
  }

  /**
   * Returns custom attributes associated with this error
   */
  @Nonnull public Map customAttributes() {
    return customAttributes;
  }

  @Override public boolean equals(Object o) {
    if (this == o) return true;
    if (!(o instanceof Error)) return false;

    Error error = (Error) o;

    if (message != null ? !message.equals(error.message) : error.message != null) return false;
    if (!locations.equals(error.locations)) return false;
    return customAttributes.equals(error.customAttributes);
  }

  @Override public int hashCode() {
    int result = message != null ? message.hashCode() : 0;
    result = 31 * result + locations.hashCode();
    result = 31 * result + customAttributes.hashCode();
    return result;
  }

  @Override public String toString() {
    return "Error{"
        + "message='" + message + '\''
        + ", locations=" + locations
        + ", customAttributes=" + customAttributes
        + '}';
  }

  /**
   * Represents the location of the error in the GraphQL operation sent to the server. This location is represented in
   * terms of the line and column number.
   */
  public static class Location {
    private final long line;
    private final long column;

    public Location(long line, long column) {
      this.line = line;
      this.column = column;
    }

    /**
     * Returns the line number of the error location.
     */
    public long line() {
      return line;
    }

    /**
     * Returns the column number of the error location.
     */
    public long column() {
      return column;
    }

    @Override public boolean equals(Object o) {
      if (this == o) return true;
      if (o == null || getClass() != o.getClass()) return false;

      Location location = (Location) o;

      //noinspection SimplifiableIfStatement
      if (line != location.line) return false;
      return column == location.column;
    }

    @Override public int hashCode() {
      int result = (int) (line ^ (line >>> 32));
      result = 31 * result + (int) (column ^ (column >>> 32));
      return result;
    }

    @Override public String toString() {
      return "Location{"
          + "line="
          + line
          + ", column="
          + column
          + '}';
    }
  }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy