dev.dejvokep.boostedyaml.route

Class RouteFactory

java.lang.Object

dev.dejvokep.boostedyaml.route.RouteFactory

public class RouteFactory
extends Object

Factory used to build routes from string routes in bulk.

As string routes can also be used to access data, you should never convert string routes using this class, except some situations where it is allowed.

Constructor Summary

Constructors

Constructor and Description
RouteFactory() Creates a factory with the defaults specified by GeneralSettings.DEFAULT_ROUTE_SEPARATOR and GeneralSettings.DEFAULT_ESCAPED_SEPARATOR.
RouteFactory(GeneralSettings generalSettings) Creates a factory with the separator specified by the given settings.
RouteFactory(char separator) Creates a factory with the given separator.

Method Summary

Modifier and Type	Method and Description
Route	create(String route) Constructs a route from the given string route, by splitting it by the factory's separator.
String	getEscapedSeparator() Returns the escaped version of getSeparator().
char	getSeparator() Returns the separator character.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteFactory

public RouteFactory(@NotNull
                    GeneralSettings generalSettings)

Creates a factory with the separator specified by the given settings.

Parameters:

generalSettings - settings from which to get the separator

RouteFactory

public RouteFactory(char separator)

Creates a factory with the given separator.

Parameters:

separator - separator to use

RouteFactory

public RouteFactory()

Creates a factory with the defaults specified by GeneralSettings.DEFAULT_ROUTE_SEPARATOR and GeneralSettings.DEFAULT_ESCAPED_SEPARATOR.

Method Detail

create

@NotNull
public Route create(String route)

Constructs a route from the given string route, by splitting it by the factory's separator.

As string routes can also be used to access data, you should never convert string routes using this method, except some situations where it is allowed.

The given keys are traversed in order as they were specified. Assuming route ["x", "y"], processor attempts to get section at key "x" in the section from which the getter/setter... method was called; and then value at key "y" in that section.

As routes are immutable objects, to save resources, it is recommended to create that certain route only once and then reuse it.

Parameters:

route - the string route to split (in format a.b for factory separator '.' to create route [a, b])

Returns:

the immutable route

getSeparator

public char getSeparator()

Returns the separator character.

Returns:

the separator character

getEscapedSeparator

@NotNull
public String getEscapedSeparator()

Returns the escaped version of getSeparator().

Returns:

the escaped separator