org.jamplate.impl.parser

Class PatternParser

java.lang.Object

org.jamplate.impl.parser.PatternParser

All Implemented Interfaces:

Parser

public class PatternParser
extends java.lang.Object
implements Parser

A parser parsing literal sketches depending on a specific pattern.

Since:

0.2.0 ~2021.04.28

Version:

0.2.0

Author:

LSafer

Field Summary

Fields

Modifier and Type	Field and Description
protected @NotNull java.util.function.BiFunction<Document,Reference,Tree>	constructor The constructor to be used to construct new trees.
protected @NotNull java.util.regex.Pattern	pattern A pattern matching the literal.
protected int	zIndex The z-index to accept.

Constructor Summary

Constructors

Constructor and Description
PatternParser(@NotNull java.util.regex.Pattern pattern) Construct a new literal parser that parses the sketches looking for areas that matches the given pattern.
PatternParser(@NotNull java.util.regex.Pattern pattern, @NotNull java.util.function.BiFunction<Document,Reference,Tree> constructor) Construct a new literal parser that parses the sketches looking for areas that matches the given pattern.
PatternParser(@NotNull java.util.regex.Pattern pattern, int zIndex) Construct a new literal parser that parses the sketches looking for areas that matches the given pattern.
PatternParser(@NotNull java.util.regex.Pattern pattern, int zIndex, @NotNull java.util.function.BiFunction<Document,Reference,Tree> constructor) Construct a new literal parser that parses the sketches looking for areas that matches the given pattern.

Method Summary

Modifier and Type	Method and Description
@NotNull java.util.Set<Tree>	parse(@NotNull Compilation compilation, @NotNull Tree tree) Parse the given sketch with respect to the given compilation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

constructor

@NotNull
protected final @NotNull java.util.function.BiFunction<Document,Reference,Tree> constructor

The constructor to be used to construct new trees.

Since:

0.2.0 ~2021.05.20

pattern

@NotNull
protected final @NotNull java.util.regex.Pattern pattern

A pattern matching the literal.

Since:

0.0.1 ~2021.04.28

zIndex

protected final int zIndex

The z-index to accept.

Since:

0.2.0 ~2021.05.31

Constructor Detail

PatternParser

public PatternParser(@NotNull
                     @NotNull java.util.regex.Pattern pattern)

Construct a new literal parser that parses the sketches looking for areas that matches the given pattern.

Parameters:

pattern - the pattern matching the areas the constructed parser will be looking for.

Throws:

java.lang.NullPointerException - if the given pattern is null.

Since:

0.2.0 ~2021.05.16

PatternParser

public PatternParser(@NotNull
                     @NotNull java.util.regex.Pattern pattern,
                     int zIndex)

Construct a new literal parser that parses the sketches looking for areas that matches the given pattern.

Parameters:

pattern - the pattern matching the areas the constructed parser will be looking for.

zIndex - the z-index to accept.

Throws:

java.lang.NullPointerException - if the given pattern is null.

Since:

0.2.0 ~2021.05.16

PatternParser

public PatternParser(@NotNull
                     @NotNull java.util.regex.Pattern pattern,
                     @NotNull
                     @NotNull java.util.function.BiFunction<Document,Reference,Tree> constructor)

Construct a new literal parser that parses the sketches looking for areas that matches the given pattern.

Parameters:

pattern - the pattern matching the areas the constructed parser will be looking for.

constructor - the constructor.

Throws:

java.lang.NullPointerException - if the given pattern or constructor is null.

Since:

0.2.0 ~2021.05.16

PatternParser

public PatternParser(@NotNull
                     @NotNull java.util.regex.Pattern pattern,
                     int zIndex,
                     @NotNull
                     @NotNull java.util.function.BiFunction<Document,Reference,Tree> constructor)

Construct a new literal parser that parses the sketches looking for areas that matches the given pattern.

Parameters:

pattern - the pattern matching the areas the constructed parser will be looking for.

zIndex - the z-index to accept.

constructor - the constructor.

Throws:

java.lang.NullPointerException - if the given pattern or constructor is null.

Since:

0.2.0 ~2021.05.16

Method Detail

parse

@NotNull
public @NotNull java.util.Set<Tree> parse(@NotNull
                                                    @NotNull Compilation compilation,
                                                    @NotNull
                                                    @NotNull Tree tree)

Description copied from interface: Parser

Parse the given sketch with respect to the given compilation.

Specified by:

parse in interface Parser

Parameters:

compilation - the compilation taking the given sketch.

tree - the sketch to be parsed.

Returns:

the parsed sketches.