Package proguard.classfile.attribute.signature.parsing

Interface Parser<T>

Type Parameters:
T - The AST node this parser will be returning.
All Known Implementing Classes:
LazyParser
public interface Parser<T>
Main interface of the parser library, used to implement custom parsers.

  • Method Summary

    Modifier and Type
    Method
    Description
    default <R> Parser<R>
    map(Function<T,R> function)
    Helper for converting a result of the parser into another type.
    default T
    parse(String input)
    Helper function to parse whole strings.
    T
    parse(ParserContext context)
    The core of the parsing logic.

  • Method Details

    • parse

      @Nullable T parse(ParserContext context)
      The core of the parsing logic. The context argument specifies where in the input string we are currently parsing. The responsibility of this function is to do one of:
      • Consume a part of the input and return a non-null value.
      • Return null and keep the input context untouched. This can be achieved either by avoiding the calls to ParserContext.advance(int), or through the use of snapshotting (see ParserContext.snapshot()).
      Parameters:
      context - Context of the parser containing the parsed string and the position in that string.
      Returns:
      Null-value if this parser did not match anything. Non-null if it matched.

    • parse

      default T parse(String input)
      Helper function to parse whole strings.
      Parameters:
      input - A string to parse.
      Returns:
      A parsed out value (likely AST) or null, if it does not match.

    • map

      default <R> Parser<R> map(Function<T,R> function)
      Helper for converting a result of the parser into another type. More or less equivalent to Stream.map(Function).
      Type Parameters:
      R - The return type of the new parser.
      Parameters:
      function - Function that should be used to map the result of the given parser.
      Returns:
      A new parser which returns the expected type.