org.jamplate.impl.parser

Class PatternRangeParser

java.lang.Object

org.jamplate.impl.parser.PatternRangeParser

All Implemented Interfaces:

Parser

public class PatternRangeParser
extends java.lang.Object
implements Parser

A parser parsing scope sketches depending on a specific starting and ending pattern.

Since:

0.2.0 ~2021.05.16

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 of the resultant tree.
protected @Nullable java.util.function.BiConsumer<Tree,Reference>[]	constructors The constructors of the components.
protected @NotNull java.util.regex.Pattern	endPattern A pattern matching the closing sequence.
protected @NotNull java.util.regex.Pattern	startPattern A pattern matching the opening sequence.
protected int	zIndex The z-index to accept.

Constructor Summary

Constructors

Constructor and Description
PatternRangeParser(@NotNull java.util.regex.Pattern startPattern, @NotNull java.util.regex.Pattern endPattern, @NotNull java.util.function.BiFunction<Document,Reference,Tree> constructor, java.util.function.BiConsumer<Tree,Reference>... constructors) Construct a new scope parser that parses the sketches looking for areas that starts with the given startPattern and ends with the given endPattern.
PatternRangeParser(@NotNull java.util.regex.Pattern startPattern, @NotNull java.util.regex.Pattern endPattern, int zIndex, @NotNull java.util.function.BiFunction<Document,Reference,Tree> constructor, java.util.function.BiConsumer<Tree,Reference>... constructors) Construct a new scope parser that parses the sketches looking for areas that starts with the given startPattern and ends with the given endPattern.

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 of the resultant tree.

Since:

0.2.0 ~2021.05.30

constructors

@Nullable
protected final @Nullable java.util.function.BiConsumer<Tree,Reference>[] constructors

The constructors of the components.

Since:

0.2.0 ~2021.05.30

endPattern

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

A pattern matching the closing sequence.

Since:

0.2.0 ~2021.05.16

startPattern

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

A pattern matching the opening sequence.

Since:

0.2.0 ~2021.05.16

zIndex

protected final int zIndex

The z-index to accept.

Since:

0.2.0 ~ 2021.05.31

Constructor Detail

PatternRangeParser

@SafeVarargs
public PatternRangeParser(@NotNull
                                        @NotNull java.util.regex.Pattern startPattern,
                                        @NotNull
                                        @NotNull java.util.regex.Pattern endPattern,
                                        int zIndex,
                                        @NotNull
                                        @NotNull java.util.function.BiFunction<Document,Reference,Tree> constructor,
                                        @Nullable
                                        java.util.function.BiConsumer<Tree,Reference>... constructors)

Construct a new scope parser that parses the sketches looking for areas that starts with the given startPattern and ends with the given endPattern.

Parameters:

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

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

zIndex - the z-index to accept.

constructor - the constructor of the result trees.

constructors - the constructors of the components.

Throws:

java.lang.NullPointerException - if the given startPattern or endPattern or constructor or constructors is null.

java.lang.IllegalArgumentException - if constructors.length > 3.

Since:

0.2.0 ~2021.05.16

PatternRangeParser

@SafeVarargs
public PatternRangeParser(@NotNull
                                        @NotNull java.util.regex.Pattern startPattern,
                                        @NotNull
                                        @NotNull java.util.regex.Pattern endPattern,
                                        @NotNull
                                        @NotNull java.util.function.BiFunction<Document,Reference,Tree> constructor,
                                        @Nullable
                                        java.util.function.BiConsumer<Tree,Reference>... constructors)

Construct a new scope parser that parses the sketches looking for areas that starts with the given startPattern and ends with the given endPattern.

Parameters:

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

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

constructor - the constructor of the result trees.

constructors - the constructors of the components.

Throws:

java.lang.NullPointerException - if the given startPattern or endPattern or constructor or constructors is null.

java.lang.IllegalArgumentException - if constructors.length > 3.

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.