Package com.io7m.jproperties.monad

Class JPropertySuccess<A>

java.lang.Object
com.io7m.jproperties.monad.JPropertySuccess<A>
Type Parameters:
A - The type of result values
All Implemented Interfaces:
JPropertyParseMonadType<A>, JPropertyParseMonadType.JPropertySuccessType<A>
public final class JPropertySuccess<A>
extends java.lang.Object
implements JPropertyParseMonadType.JPropertySuccessType<A>
A result indicating success.

  • Method Details

    • warnings

      public java.util.List<JPropertyWarning> warnings()
      Specified by:
      warnings in interface JPropertyParseMonadType<A>
      Returns:
      The accumulated warnings

    • errors

      public java.util.List<JPropertyError> errors()
      Specified by:
      errors in interface JPropertyParseMonadType<A>
      Returns:
      The accumulated errors

    • result

      public A result()
      Specified by:
      result in interface JPropertyParseMonadType.JPropertySuccessType<A>
      Returns:
      The result of parsing

    • withWarnings

      public final JPropertySuccess<A> withWarnings​(JPropertyWarning... elements)
      Copy the current immutable object with elements that replace the content of warnings.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withWarnings

      public final JPropertySuccess<A> withWarnings​(java.lang.Iterable<? extends JPropertyWarning> elements)
      Copy the current immutable object with elements that replace the content of warnings. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of warnings elements to set
      Returns:
      A modified copy of this object

    • withErrors

      public final JPropertySuccess<A> withErrors​(JPropertyError... elements)
      Copy the current immutable object with elements that replace the content of errors.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withErrors

      public final JPropertySuccess<A> withErrors​(java.lang.Iterable<? extends JPropertyError> elements)
      Copy the current immutable object with elements that replace the content of errors. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of errors elements to set
      Returns:
      A modified copy of this object

    • withResult

      public final JPropertySuccess<A> withResult​(A value)
      Copy the current immutable object by setting a value for the result attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for result
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals​(java.lang.Object another)
      This instance is equal to all instances of JPropertySuccess 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: warnings, errors, result.
      Overrides:
      hashCode in class java.lang.Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

      public static <A> JPropertySuccess<A> copyOf​(JPropertyParseMonadType.JPropertySuccessType<A> instance)
      Creates an immutable copy of a JPropertyParseMonadType.JPropertySuccessType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Type Parameters:
      A - generic parameter A
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable JPropertySuccess instance

    • builder

      public static <A> JPropertySuccess.Builder<A> builder()
      Creates a builder for JPropertySuccess. 
       JPropertySuccess.&lt;A&gt;builder()
    .addWarnings|addAllWarnings(JPropertyWarning) // warnings elements
    .addErrors|addAllErrors(JPropertyError) // errors elements
    .setResult(A) // required result
    .build();
      Type Parameters:
      A - generic parameter A
      Returns:
      A new JPropertySuccess builder