Package com.io7m.jproperties.monad

Class JPropertyError

java.lang.Object
com.io7m.jproperties.monad.JPropertyError
All Implemented Interfaces:
JPropertyParseMonadType.JPropertyErrorType
public final class JPropertyError
extends java.lang.Object
implements JPropertyParseMonadType.JPropertyErrorType
The type of parse errors.

  • Method Details

    • message

      public java.lang.String message()
      Specified by:
      message in interface JPropertyParseMonadType.JPropertyErrorType
      Returns:
      The error message

    • withMessage

      public final JPropertyError withMessage​(java.lang.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​(java.lang.Object another)
      This instance is equal to all instances of JPropertyError that have equal attribute values.
      Overrides:
      equals in class java.lang.Object
      Returns:
      true if this is equal to another instance

    • hashCode

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

    • toString

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

    • of

      public static JPropertyError of​(java.lang.String message)
      Construct a new immutable JPropertyError instance.
      Parameters:
      message - The value for the message attribute
      Returns:
      An immutable JPropertyError instance

    • copyOf

      public static JPropertyError copyOf​(JPropertyParseMonadType.JPropertyErrorType instance)
      Creates an immutable copy of a JPropertyParseMonadType.JPropertyErrorType 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 JPropertyError instance

    • builder

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