Package dev.prozilla.pine.common.util.parser

Class Parser<T>

java.lang.Object
dev.prozilla.pine.common.util.parser.Parser<T>
Type Parameters:
T - The type of the result.
All Implemented Interfaces:
Printable
Direct Known Subclasses:
AnimationCurveParser, ColorParser, ColourParser, DimensionParser, DualDimensionParser, EnumParser, ListParser, SequentialParser, SimpleParser, Vector2f.Parser, Vector2i.Parser, Vector3f.Parser, Vector3i.Parser, Vector4f.Parser, Vector4i.Parser
public abstract class Parser<T> extends Object implements Printable
Abstract class for a stateful parser.

  • Field Details

  • Constructor Details

    • Parser

      public Parser()

  • Method Details

    • read

      public T read(String input) throws ParsingException
      Parses an input string and throws an exception if the parsing fails.
      Parameters:
      input - The input string to parse
      Returns:
      The parsed value
      Throws:
      ParsingException - If this parser failed to parse the input string.

    • getResult

      public T getResult()
      Returns the result or null, if the parsing failed and removes it.
      Returns:
      The result

    • getError

      public String getError()
      Returns the error message or null, if the parsing succeeded and removes it.
      Returns:
      The error message

    • parse

      public abstract boolean parse(String input)
      Parses a string.
      Parameters:
      input - The input string to parse
      Returns:
      true if the parsing succeeded.

    • succeed

      @Contract("null -> fail; _ -> true") protected boolean succeed(T result)

    • fail

      @Contract("-> false") protected boolean fail()

    • fail

      @Contract("null -> fail; _ -> false") protected boolean fail(String errorMessage)

    • parseProperty

      @Contract("_ -> new") public ParsedProperty<T> parseProperty(StringProperty inputProperty)
      Creates a property whose value is the result of parsing the value of a string property.
      Parameters:
      inputProperty - The input property
      Returns:
      The parsed property.

    • toString

      @NotNull public @NotNull String toString()
      Description copied from interface: Printable
      Returns a string representation of this object.
      Specified by:
      toString in interface Printable
      Overrides:
      toString in class Object
      Returns:
      String representation of this object.