Package com.blamejared.searchables.api.autcomplete

Class CompletionVisitor

java.lang.Object

com.blamejared.searchables.api.autcomplete.CompletionVisitor

All Implemented Interfaces:

Visitor<TokenRange>, Consumer<String>

public class CompletionVisitor
extends Object
implements Visitor<TokenRange>, Consumer<String>

Generates a list of TokenRanges that can be used to split a given string into parts. Mainly used to split strings for completion purposes.

Constructor Summary

Constructors

Constructor	Description
CompletionVisitor()

Method Summary

Modifier and Type	Method	Description
void	accept(String search)	Resets this visitor and compiles a list of TokenRange from the given String
TokenRange	postVisit(TokenRange obj)
TokenRange	rangeAt(int position)	Gets the TokenRange at the given position, or TokenRange.EMPTY if out of bounds.
protected void	reduceTokens()	Reduces the tokens into their outermost parts.
void	reset()	Resets this visitor to a state that allows it to run again.
Optional<TokenRange>	tokenAt(int position)	Gets the Optional<TokenRange> at the given position.
List<TokenRange>	tokens()	Gets the tokens in this visitor.
TokenRange	visitComponent(ComponentExpression expr)
TokenRange	visitGrouping(GroupingExpression expr)
TokenRange	visitLiteral(LiteralExpression expr)
TokenRange	visitPaired(PairedExpression expr)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Details

CompletionVisitor

public CompletionVisitor()

Method Details

reset

public void reset()

Resets this visitor to a state that allows it to run again.

reduceTokens

protected void reduceTokens()

Reduces the tokens into their outermost parts. For example the string "shape:square color:red" will be split into: [ TokenRange(0, 12, [TokenRange(0, 5), TokenRange(5, 6), TokenRange(6, 12)]), TokenRange(13, 22, [TokenRange(13, 18), TokenRange(18, 19), TokenRange(19, 22)]) ]

tokens

public List<TokenRange> tokens()

Gets the tokens in this visitor.

Returns:

The tokens in this visitor.

tokenAt

public Optional<TokenRange> tokenAt(int position)

Gets the Optional<TokenRange> at the given position.

Parameters:

position - The current cursor position.

Returns:

An Optional<TokenRange> at the given position, or an empty optional if out of bounds.

rangeAt

public TokenRange rangeAt(int position)

Gets the TokenRange at the given position, or TokenRange.EMPTY if out of bounds.

Parameters:

position - The current cursor position.

Returns:

An TokenRange at the given range, or TokenRange.EMPTY if out of bounds.

visitGrouping

public TokenRange visitGrouping(GroupingExpression expr)

Specified by:

visitGrouping in interface Visitor<TokenRange>

visitComponent

public TokenRange visitComponent(ComponentExpression expr)

Specified by:

visitComponent in interface Visitor<TokenRange>

visitLiteral

public TokenRange visitLiteral(LiteralExpression expr)

Specified by:

visitLiteral in interface Visitor<TokenRange>

visitPaired

public TokenRange visitPaired(PairedExpression expr)

Specified by:

visitPaired in interface Visitor<TokenRange>

accept

public void accept(String search)

Resets this visitor and compiles a list of TokenRange from the given String

Specified by:

accept in interface Consumer<String>

Parameters:

search - The string to search

postVisit

public TokenRange postVisit(TokenRange obj)

Specified by:

postVisit in interface Visitor<TokenRange>