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 with the same separator in bulk.

Please note that string routes can also be used as Route objects, therefore you should not introduce additional overhead by converting them using methods provided by this class, unless necessarily needed.

Constructor Summary

Constructors

Constructor and Description
RouteFactory() Creates a factory with the default separator defined by GeneralSettings.DEFAULT_ROUTE_SEPARATOR.
RouteFactory(GeneralSettings generalSettings) Creates a factory with the given setting's separator.
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 by splitting the given string route by the factory's separator.
String	getEscapedSeparator() Returns the escaped separator.
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 given setting's separator.

Parameters:

generalSettings - provider of the separator to use

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 default separator defined by GeneralSettings.DEFAULT_ROUTE_SEPARATOR.

Method Detail

create

@NotNull
public Route create(String route)

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

For example, giving string route "a.b" will return the equivalent route containing 2 keys: ["a", "b"].

Please note that string routes can also be used as Route objects, therefore you should not introduce additional overhead by converting them using methods provided by this class, unless necessarily needed.

Parameters:

route - the string route to split

Returns:

the route

See Also:

implementation information

getSeparator

public char getSeparator()

Returns the separator character.

Returns:

the separator character

getEscapedSeparator

@NotNull
public String getEscapedSeparator()

Returns the escaped separator.

Returns:

the escaped separator