AbstractParser (uk.co.strangeskies)

Type Parameters:

T - the type of the object created by successful application of the Parser to a piece of text

All Superinterfaces:

Parser<T>

All Known Implementing Classes:

AppendingParser, ChoiceParser, DateTimeParser, JoiningParser, ParserProxy, PrependingParser, RegexParser
```
public interface AbstractParser<T>
extends Parser<T>
```
A partial implementation of Parser with sensible default behavior provided for a large number of methods.

Field Summary
- Fields inherited from interface uk.co.strangeskies.text.parsing.Parser
  MATCHING_ALL

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default <U,V> Parser<V>`	`appendTransform(Parser<U> parser, java.util.function.BiFunction<T,U,? extends V> incorporate)` Derive a new `Parser` instance from the receiving instance.
`default <U> Parser<U>`	`appendTransform(java.lang.String pattern, java.util.function.BiFunction<T,java.lang.String,? extends U> incorporate)` Derive a new `Parser` instance from the receiving instance.
`default Parser<T>`	`orElse(Parser<? extends T> onFailure)` Derive a new `Parser` instance from the receiving instance.
`default Parser<T>`	`orElse(java.util.function.Supplier<? extends T> onFailure)` Derive a new `Parser` instance from the receiving instance.
`default T`	`parse(java.lang.String literal)` Parse the given literal according to this parser.
`default ParseResult<T>`	`parseSubstring(ParseState currentState)` Parse the substring at the given parse state according to this parser.
`ParseResult<T>`	`parseSubstringImpl(ParseState currentState)`
`default <U,V> Parser<V>`	`prependTransform(Parser<U> parser, java.util.function.BiFunction<T,U,? extends V> incorporate)` Derive a new `Parser` instance from the receiving instance.
`default <U> Parser<U>`	`prependTransform(java.lang.String pattern, java.util.function.BiFunction<T,java.lang.String,? extends U> incorporate)` Derive a new `Parser` instance from the receiving instance.
`default <W> Parser<W>`	`transform(java.util.function.Function<? super T,? extends W> transform)` Derive a new `Parser` instance from the receiving instance.
`default <U> Parser<T>`	`tryAppendTransform(Parser<U> parser, java.util.function.BiFunction<T,U,? extends T> incorporate)` Derive a new `Parser` instance from the receiving instance.
`default <U> Parser<T>`	`tryPrependTransform(Parser<U> parser, java.util.function.BiFunction<T,U,? extends T> incorporate)` Derive a new `Parser` instance from the receiving instance.

Methods inherited from interface uk.co.strangeskies.text.parsing.Parser
append, append, append, from, list, list, matching, matchingAll, matchingAll, orElse, prepend, prepend, prepend, proxy, tryAppend, tryPrepend

- Method Detail
 - transform
```
default <W> Parser<W> transform(java.util.function.Function<? super T,? extends W> transform)
```
 Description copied from interface: Parser
 
 Derive a new Parser instance from the receiving instance.
 The new parser will match the same text as the given parser, but the object parsed will be transformed by the given Function.
 
 Specified by:
 
 transform in interface Parser<T>
 
 Type Parameters:
 
 W - the type of the object of the new parser, post-transformation
 
 Parameters:
 
 transform - the transformation to apply to the object given by application of this parser
 
 Returns:
 
 a new Parser instance which applies the given transformation
 - orElse
```
default Parser<T> orElse(java.util.function.Supplier<? extends T> onFailure)
```
 Description copied from interface: Parser
 
 Derive a new Parser instance from the receiving instance.
 The new parser will attempt to match a piece of text in the same manner as the receiving parser. If the attempt fails, the text matched, or partially matched, by the original attempt will remain unconsumed, and the parser will instead return a value from the given supplier.
 
 Specified by:
 
 orElse in interface Parser<T>
 
 Parameters:
 
 onFailure - The supplier for the object the new parser should return if application of the original parser fails
 
 Returns:
 
 A new Parser instance which includes the given failure guard
 - orElse
```
default Parser<T> orElse(Parser<? extends T> onFailure)
```
 Description copied from interface: Parser
 
 Derive a new Parser instance from the receiving instance.
 The new parser will attempt to match a piece of text in the same manner as the receiving parser. If the attempt fails, the text matched, or partially matched, by the original attempt will remain unconsumed, then an attempt will be made to instead apply the given parser.
 
 Specified by:
 
 orElse in interface Parser<T>
 
 Parameters:
 
 onFailure - The parser which should be applied if and when application of the original parser fails
 
 Returns:
 
 A new Parser instance which includes the given failure guard
 - appendTransform
```
default  Parser appendTransform(java.lang.String pattern,
 java.util.function.BiFunction<T,java.lang.String,? extends U> incorporate)
```
 Description copied from interface: Parser
 
 Derive a new Parser instance from the receiving instance.
 The new parser will first match the start of the text according to the receiving parser, then match the start of any subsequent text according to the given pattern.
 Upon success, the text matched by the appended pattern will be transformed, along with the result of applying the receiving parser, into a new result according to the given function.
 
 Specified by:
 
 appendTransform in interface Parser<T>
 
 Type Parameters:
 
 U - The type of the new parse result
 
 Parameters:
 
 pattern - A pattern matching the text which should immediately follow from the text matched by this parser
 
 incorporate - A function taking the result of parsing the receiving parser and the appended text, and transforming them into a new parse result
 
 Returns:
 
 A new Parser instance which also matches against the appended text pattern
 - prependTransform
```
default  Parser prependTransform(java.lang.String pattern,
 java.util.function.BiFunction<T,java.lang.String,? extends U> incorporate)
```
 Description copied from interface: Parser
 
 Derive a new Parser instance from the receiving instance.
 The new parser will first match the start of the text according to the given pattern, then match the start of any subsequent text according to the receiving parser.
 Upon success, the text matched by the appended pattern will be transformed, along with the result of applying the receiving parser, into a new result according to the given function.
 
 Specified by:
 
 prependTransform in interface Parser<T>
 
 Type Parameters:
 
 U - The type of the new parse result
 
 Parameters:
 
 pattern - A pattern matching the text which should immediately precede the text matched by this parser
 
 incorporate - A function taking the result of parsing the receiving parser and the prepending text, and transforming them into a new parse result
 
 Returns:
 
 A new Parser instance which also matches against the prepended text pattern
 - appendTransform
```
default <U,V> Parser<V> appendTransform(Parser parser,
 java.util.function.BiFunction<T,U,? extends V> incorporate)
```
 Description copied from interface: Parser
 
 Derive a new Parser instance from the receiving instance.
 The new parser will first match the start of the text according to the receiving parser, then match the start of any subsequent text according to the given parser.
 Upon success, the result of applying the appended parser will be transformed, along with the result of applying the receiving parser, into a new result according to the given function.
 
 Specified by:
 
 appendTransform in interface Parser<T>
 
 Type Parameters:
 
 U - The type of the parse result of the appended parser
 
 V - The type of the new parse result
 
 Parameters:
 
 parser - A parser matching the text immediately following from the text matched by this parser
 
 incorporate - A function taking the result of parsing the receiving parser and the result of parsing the appended parser, and transforming them into a new parse result
 
 Returns:
 
 A new Parser instance which also matches against the appended parser
 - prependTransform
```
default <U,V> Parser<V> prependTransform(Parser parser,
 java.util.function.BiFunction<T,U,? extends V> incorporate)
```
 Description copied from interface: Parser
 
 Derive a new Parser instance from the receiving instance.
 The new parser will first match the start of the text according to the given parser, then match the start of any subsequent text according to the receiving parser.
 Upon success, the result of applying the prepended parser will be transformed, along with the result of applying the receiving parser, into a new result according to the given function.
 
 Specified by:
 
 prependTransform in interface Parser<T>
 
 Type Parameters:
 
 U - The type of the parse result of the appended parser
 
 V - The type of the new parse result
 
 Parameters:
 
 parser - A parser matching the text immediately preceding the text matched by this parser
 
 incorporate - A function taking the result of parsing the receiving parser and the result of parsing the appended parser, and transforming them into a new parse result
 
 Returns:
 
 A new Parser instance which also matches against the appended parser
 - tryAppendTransform
```
default  Parser<T> tryAppendTransform(Parser parser,
 java.util.function.BiFunction<T,U,? extends T> incorporate)
```
 Description copied from interface: Parser
 
 Derive a new Parser instance from the receiving instance.
 The new parser will first match the start of the text according to the receiving parser, then attempt to match the start of any subsequent text according to the given parser. If the second step - of matching the remaining text with the given parser - fails, then the result of applying the receiving parser alone will be returned.
 If application of the appended parser also succeeds, the result of applying the appended parser will be transformed, along with the result of applying the receiving parser, into a new result according to the given function.
 
 Specified by:
 
 tryAppendTransform in interface Parser<T>
 
 Type Parameters:
 
 U - The type of the parse result of the appended parser
 
 Parameters:
 
 parser - A parser matching the text immediately following from the text matched by this parser
 
 incorporate - A function taking the result of parsing the receiving parser and the result of parsing the appended parser, and transforming them into a new parse result
 
 Returns:
 
 A new Parser instance which also matches against the appended parser
 - tryPrependTransform
```
default  Parser<T> tryPrependTransform(Parser parser,
 java.util.function.BiFunction<T,U,? extends T> incorporate)
```
 Description copied from interface: Parser
 
 Derive a new Parser instance from the receiving instance.
 The new parser will first match the start of the text according to the given parser, then attempt to match the start of any subsequent text according to the receiving parser. If the first step - of matching the remaining text with the given parser - fails, then the result of applying the receiving parser alone will be returned.
 If application of the prepended parser also succeeds, the result of applying the prepended parser will be transformed, along with the result of applying the receiving parser, into a new result according to the given function.
 
 Specified by:
 
 tryPrependTransform in interface Parser<T>
 
 Type Parameters:
 
 U - The type of the parse result of the appended parser
 
 Parameters:
 
 parser - A parser matching the text immediately following from the text matched by this parser
 
 incorporate - A function taking the result of parsing the receiving parser and the result of parsing the appended parser, and transforming them into a new parse result
 
 Returns:
 
 A new Parser instance which also matches against the appended parser
 - parse
```
default T parse(java.lang.String literal)
```
 Description copied from interface: Parser
 
 Parse the given literal according to this parser.
 
 Specified by:
 
 parse in interface Parser<T>
 
 Parameters:
 
 literal - the string literal to parse
 
 Returns:
 
 the object result of parsing
 - parseSubstring
```
default ParseResult<T> parseSubstring(ParseState currentState)
```
 Description copied from interface: Parser
 
 Parse the substring at the given parse state according to this parser.
 
 Specified by:
 
 parseSubstring in interface Parser<T>
 
 Parameters:
 
 currentState - the current parse state over a string literal
 
 Returns:
 
 the object result of parsing
 - parseSubstringImpl
```
ParseResult<T> parseSubstringImpl(ParseState currentState)
```

Interface AbstractParser<T>

Field Summary

Fields inherited from interface uk.co.strangeskies.text.parsing.Parser

Method Summary

Methods inherited from interface uk.co.strangeskies.text.parsing.Parser

Method Detail

transform

orElse

orElse

appendTransform

prependTransform

appendTransform

prependTransform

tryAppendTransform

tryPrependTransform

parse

parseSubstring

parseSubstringImpl