Package com.io7m.coffeepick.runtime.parser.api

Class CoffeePickParseRequest

java.lang.Object
com.io7m.coffeepick.runtime.parser.api.CoffeePickParseRequest
All Implemented Interfaces:
CoffeePickParseRequestType
public final class CoffeePickParseRequest
extends java.lang.Object
implements CoffeePickParseRequestType
A request to parse something.

  • Method Details

    • uri

      public java.net.URI uri()
      Specified by:
      uri in interface CoffeePickParseRequestType
      Returns:
      The URI of the input stream, for diagnostics

    • stream

      public java.io.InputStream stream()
      Specified by:
      stream in interface CoffeePickParseRequestType
      Returns:
      The input stream

    • withUri

      public final CoffeePickParseRequest withUri​(java.net.URI value)
      Copy the current immutable object by setting a value for the uri attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for uri
      Returns:
      A modified copy of the this object

    • withStream

      public final CoffeePickParseRequest withStream​(java.io.InputStream value)
      Copy the current immutable object by setting a value for the stream attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for stream
      Returns:
      A modified copy of the this object

    • equals

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

    • toString

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

    • copyOf

      public static CoffeePickParseRequest copyOf​(CoffeePickParseRequestType instance)
      Creates an immutable copy of a CoffeePickParseRequestType 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 CoffeePickParseRequest instance

    • builder

      public static CoffeePickParseRequest.Builder builder()
      Creates a builder for CoffeePickParseRequest. 
       CoffeePickParseRequest.builder()
    .setUri(java.net.URI) // required uri
    .setStream(java.io.InputStream) // required stream
    .build();
      Returns:
      A new CoffeePickParseRequest builder