org.simpleyaml.configuration.comments

Class KeyTree

java.lang.Object

org.simpleyaml.configuration.comments.KeyTree

All Implemented Interfaces:

Iterable<KeyTree.Node>

Direct Known Subclasses:

YamlKeyTree

public class KeyTree
extends Object
implements Iterable<KeyTree.Node>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	KeyTree.Node

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationOptions	options
protected KeyTree.Node	root

Constructor Summary

Constructors

Constructor and Description
KeyTree(ConfigurationOptions options)

Method Summary

Modifier and Type	Method and Description
KeyTree.Node	add(String path) Get a child from its path.
List<KeyTree.Node>	children()
protected KeyTree.Node	createNode(KeyTree.Node parent, int indent, String key)
Set<Map.Entry<String,KeyTree.Node>>	entries()
KeyTree.Node	findParent(int indent) Get the last node that can be a parent of a child with the indent provided.
protected KeyTree.Node	findParent(KeyTree.Node parent, int indent)
KeyTree.Node	get(String path) Get a child from its path.
KeyTree.Node	getOrAdd(String path) Get a child from its path.
KeyTree.Node	getPriority(String path) Get a child from its path.
KeyTree.Node	getRoot() Get the root node.
Iterator<KeyTree.Node>	iterator()
Set<String>	keys()
ConfigurationOptions	options()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

root

protected final KeyTree.Node root

options

protected final ConfigurationOptions options

Constructor Detail

KeyTree

public KeyTree(ConfigurationOptions options)

Method Detail

findParent

public KeyTree.Node findParent(int indent)

Get the last node that can be a parent of a child with the indent provided.

Parameters:

indent - the indent to look for

Returns:

the last most inner child that has less indent than the indent provided, or parent otherwise

getRoot

public KeyTree.Node getRoot()

Get the root node.

Returns:

the root node of this key tree

get

public KeyTree.Node get(String path)

Get a child from its path. May contain repetitions with list elements when using names (values can be repeated on a list).

Parameters:

path - the path of names to look for separated by options() ConfigurationOptions.pathSeparator()

Returns:

the child that has the provided path or null if not found

getPriority

public KeyTree.Node getPriority(String path)

Get a child from its path. Repetitions on list values are only allowed to keys inserted with priority using add(String).

Parameters:

path - the path of names to look for separated by options() ConfigurationOptions.pathSeparator()

Returns:

the child that has the provided path or null if not found

getOrAdd

public KeyTree.Node getOrAdd(String path)

Get a child from its path. It is created if it does not exist.

Parameters:

path - the path of names to look for separated by options() ConfigurationOptions.pathSeparator()

Returns:

the child that has the provided path

add

public KeyTree.Node add(String path)

Get a child from its path. It is created with priority if it does not exist.

Parameters:

path - the path of names to look for separated by options() ConfigurationOptions.pathSeparator()

Returns:

the child that has the provided path

keys

public Set<String> keys()

children

public List<KeyTree.Node> children()

entries

public Set<Map.Entry<String,KeyTree.Node>> entries()

options

public ConfigurationOptions options()

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<KeyTree.Node> iterator()

Specified by:

iterator in interface Iterable<KeyTree.Node>

findParent

protected KeyTree.Node findParent(KeyTree.Node parent,
                                  int indent)

createNode

protected KeyTree.Node createNode(KeyTree.Node parent,
                                  int indent,
                                  String key)