Module org.github.gestalt.core

Package org.github.gestalt.config.path.mapper

Interface PathMapper

All Known Implementing Classes:

DotNotationPathMapper, KebabCasePathMapper, SnakeCasePathMapper, StandardPathMapper

public interface PathMapper

Interface to map a sentance to a list of tokens.

Method Summary

Modifier and Type	Method	Description
default void	applyConfig(GestaltConfig config)	Apply the GestaltConfig to the PathMapper.
GResultOf<java.util.List<Token>>	map(java.lang.String path, java.lang.String sentence, SentenceLexer lexer)	Takes a sentance and converts it into a set of tokens to navigate.

Method Detail

applyConfig

default void applyConfig(GestaltConfig config)

Apply the GestaltConfig to the PathMapper. Needed when building via the ServiceLoader It is a default method as most Path Mapper don't need to apply configs.

Parameters:

config - GestaltConfig to update the PathMapper

map

GResultOf<java.util.List<Token>> map(java.lang.String path,
                                     java.lang.String sentence,
                                     SentenceLexer lexer)

Takes a sentance and converts it into a set of tokens to navigate.

Parameters:

path - the current path we are looking in

sentence - the next segment of the path to check

lexer - the sentence lexer used to tokenize the sentence.

Returns:

the list of tokens to check in the path