Package com.github.gpluscb.ggjava.api.exception

Class GGError

  • public class GGError
extends java.lang.Object
    Represents a single error element from the errors field of the smash.gg api response.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  GGError.Location
      Represents the location of an error.

    • Constructor Summary

      Constructors 
      Constructor Description
      GGError​(com.google.gson.JsonObject errorRoot)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getErrorId()
      The errorId field of the response.
      com.google.gson.JsonObject getErrorRoot()
      The unprocessed JsonObject of the error.
      com.google.gson.JsonObject getExtensions()
      The unprocessed extensions field of the response.
      java.util.List<GGError.Location> getLocations()
      The locations field.
      java.lang.String getMessage()
      The message field of the error.
      com.google.gson.JsonArray getPath()
      The unprocessed path field of the response.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • GGError

        public GGError​(@Nonnull
               com.google.gson.JsonObject errorRoot)
        Throws:
        java.lang.IllegalArgumentException - if errorRoot is null

    • Method Detail

      • getErrorRoot

        @Nonnull
public com.google.gson.JsonObject getErrorRoot()
        The unprocessed JsonObject of the error.
        Returns:
        the error root

      • getMessage

        @Nullable
public java.lang.String getMessage()
        The message field of the error.
        Returns:
        the message field

      • getPath

        @Nullable
public com.google.gson.JsonArray getPath()
        The unprocessed path field of the response.
        Returns:
        the path field

      • getExtensions

        @Nullable
public com.google.gson.JsonObject getExtensions()
        The unprocessed extensions field of the response.
        Returns:
        the extensions field

      • getErrorId

        @Nullable
public java.lang.String getErrorId()
        The errorId field of the response.
        Returns:
        the errorId field