Package com.io7m.brooklime.api

Class BLNexusError

java.lang.Object
com.io7m.brooklime.api.BLNexusError
All Implemented Interfaces:
BLNexusErrorType
public final class BLNexusError extends Object implements BLNexusErrorType
An error returned by the Nexus API.

  • Method Details

    • id

      public String id()
      Specified by:
      id in interface BLNexusErrorType
      Returns:
      The error ID

    • message

      public String message()
      Specified by:
      message in interface BLNexusErrorType
      Returns:
      The error message

    • withId

      public final BLNexusError withId(String value)
      Copy the current immutable object by setting a value for the id attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for id
      Returns:
      A modified copy of the this object

    • withMessage

      public final BLNexusError withMessage(String value)
      Copy the current immutable object by setting a value for the message attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for message
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(Object another)
      This instance is equal to all instances of BLNexusError that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: id, message.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value BLNexusError with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • copyOf

      public static BLNexusError copyOf(BLNexusErrorType instance)
      Creates an immutable copy of a BLNexusErrorType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable BLNexusError instance

    • builder

      public static BLNexusError.Builder builder()
      Creates a builder for BLNexusError. 
       BLNexusError.builder()
    .setId(String) // required id
    .setMessage(String) // required message
    .build();
      Returns:
      A new BLNexusError builder