ch.jalu.configme.resource

Class PropertyPathTraverser.PathElement

java.lang.Object

ch.jalu.configme.resource.PropertyPathTraverser.PathElement

Enclosing class:

PropertyPathTraverser

public static class PropertyPathTraverser.PathElement
extends Object

Represents the current element of a path which is currently being handled. This consists of a part of a property's path or may be a property's full path.

Constructor Summary

Constructors

Constructor and Description
PathElement(int indentationLevel, @NotNull String name, @NotNull String fullPath, boolean isFirstElement)

Method Summary

Modifier and Type	Method and Description
@NotNull String	getFullPath()
int	getIndentationLevel()
@NotNull String	getName()
boolean	isEndOfPath() Returns whether this path element represents the final part of a path, indicating that it is associated with a property.
boolean	isFirstElement()
boolean	isFirstOfGroup() Returns if this path element is the first new path element of a property.
protected void	setEndOfPath(boolean isEndOfPath)
protected void	setFirstOfGroup(boolean firstOfGroup)

Methods inherited from class java.lang.Object

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

Constructor Detail

PathElement

public PathElement(int indentationLevel,
                   @NotNull
                   @NotNull String name,
                   @NotNull
                   @NotNull String fullPath,
                   boolean isFirstElement)

Method Detail

getIndentationLevel

public int getIndentationLevel()

Returns:

the hierarchy level of this path element

getName

@NotNull
public @NotNull String getName()

Returns:

the name of this path element (e.g. "driver")

getFullPath

@NotNull
public @NotNull String getFullPath()

Returns:

the full path of this element (e.g. "config.datasource.driver")

isFirstElement

public boolean isFirstElement()

Returns:

true if this path element is the very first element returned by the traverser; false otherwise

isFirstOfGroup

public boolean isFirstOfGroup()

Returns if this path element is the first new path element of a property. For example, if a property config.datasource.mysql.type was previously processed and we're now processing the path config.datasource.driver.version, then the path element representing driver is considered to be the first of the group.

Returns:

true if this path element is the first new element of the path, false otherwise

setFirstOfGroup

protected void setFirstOfGroup(boolean firstOfGroup)

isEndOfPath

public boolean isEndOfPath()

Returns whether this path element represents the final part of a path, indicating that it is associated with a property. For example, given a property config.datasource.driver.version, the path element for version returns true for this method.

Returns:

true if this element is the last part of the path (i.e. if it's a "leaf element")

setEndOfPath

protected void setEndOfPath(boolean isEndOfPath)