Package cc.carm.lib.configuration.source.loader

Class PathGenerator

java.lang.Object

cc.carm.lib.configuration.source.loader.PathGenerator

public class PathGenerator
extends Object

Path generator for configuration.

Path generator is a utility class that helps to generate the path of the configuration. It can be used to generate the path of the field or class.

Field Summary

Fields

Modifier and Type	Field	Description
protected UnaryOperator<String>	pathConverter

Constructor Summary

Constructors

Constructor	Description
PathGenerator(UnaryOperator<String> pathConverter)

Method Summary

Modifier and Type	Method	Description
String	covertPath(String name)
static String	covertPathName(String name)	Get the configuration name of the specified element.
@Nullable String	getClassPath(@NotNull ConfigurationHolder<?> holder, @Nullable String parentPath, @NotNull Class<?> clazz, @Nullable Field clazzField)
@Nullable String	getFieldPath(@NotNull ConfigurationHolder<?> holder, @Nullable String parentPath, @NotNull Field field)
@NotNull UnaryOperator<String>	getPathConverter()
static boolean	isBlank(String path)
protected @Nullable String	link(@NotNull ConfigurationHolder<?> holder, @Nullable String parent, boolean root, @Nullable String path)
static PathGenerator	of()
static PathGenerator	of(UnaryOperator<String> pathConverter)
static char	pathSeparator(ConfigurationHolder<?> holder)
protected String	select(String path, String defaultValue)
void	setPathConverter(UnaryOperator<String> pathConverter)

Methods inherited from class java.lang.Object

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

Field Details

pathConverter

protected UnaryOperator<String> pathConverter

Constructor Details

PathGenerator

public PathGenerator(UnaryOperator<String> pathConverter)

Method Details

of

public static PathGenerator of()

of

public static PathGenerator of(UnaryOperator<String> pathConverter)

getPathConverter

@NotNull
public @NotNull UnaryOperator<String> getPathConverter()

setPathConverter

public void setPathConverter(UnaryOperator<String> pathConverter)

covertPath

public String covertPath(String name)

getFieldPath

@Nullable
public @Nullable String getFieldPath(@NotNull
 @NotNull ConfigurationHolder<?> holder,
 @Nullable
 @Nullable String parentPath,
 @NotNull
 @NotNull Field field)

getClassPath

@Nullable
public @Nullable String getClassPath(@NotNull
 @NotNull ConfigurationHolder<?> holder,
 @Nullable
 @Nullable String parentPath,
 @NotNull
 @NotNull Class<?> clazz,
 @Nullable
 @Nullable Field clazzField)

select

protected String select(String path,
 String defaultValue)

link

@Nullable
protected @Nullable String link(@NotNull
 @NotNull ConfigurationHolder<?> holder,
 @Nullable
 @Nullable String parent,
 boolean root,
 @Nullable
 @Nullable String path)

isBlank

public static boolean isBlank(String path)

pathSeparator

public static char pathSeparator(ConfigurationHolder<?> holder)

covertPathName

public static String covertPathName(String name)

Get the configuration name of the specified element. Use the naming convention of all lowercase and "-" links.

e.g. "SOME_NAME" will be "some-name"

Parameters:

name - source name

Returns:

the final path