org.simpleyaml.configuration.comments

Class KeyTree.Node

java.lang.Object

org.simpleyaml.configuration.comments.KeyTree.Node

All Implemented Interfaces:

Iterable<KeyTree.Node>

Direct Known Subclasses:

YamlKeyTree.YamlCommentNode

Enclosing class:

KeyTree

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

Field Summary

Fields

Modifier and Type	Field and Description
protected List<KeyTree.Node>	children
protected String	comment
protected Integer	elementIndex
protected int	indent
protected Map<Integer,KeyTree.Node>	indexByElementIndex
protected Map<String,KeyTree.Node>	indexByName
protected boolean	isList
protected Integer	listSize
protected String	name
protected KeyTree.Node	parent
protected Map<String,KeyTree.Node>	priorityIndex
protected String	sideComment

Method Summary

Modifier and Type	Method and Description
KeyTree.Node	add(int indent, String key)
protected KeyTree.Node	add(int indent, String key, boolean priority)
KeyTree.Node	add(String key)
protected KeyTree.Node	add(String key, boolean priority)
protected void	checkList()
List<KeyTree.Node>	children()
void	clear()
boolean	clearIf(Predicate<KeyTree.Node> condition)
protected boolean	clearIf(Predicate<KeyTree.Node> condition, boolean removeFromParent)
protected void	clearNode()
Set<Map.Entry<String,KeyTree.Node>>	entries()
KeyTree.Node	get(int i) Get a child from its index.
KeyTree.Node	get(String path) Get a child from its path.
protected KeyTree.Node	get(String path, boolean add, boolean priority) Get a child from its path, or optionally add a new one if it is not created.
String	getComment()
KeyTree.Node	getElement(int i) Get a child list element from its index.
protected KeyTree.Node	getElement(int i, boolean add) Get a child list element from its index, or optionally add a new one if it is not created.
Integer	getElementIndex()
KeyTree.Node	getFirst()
int	getIndentation()
KeyTree.Node	getLast()
Integer	getListSize()
String	getName()
KeyTree.Node	getParent()
String	getPath()
String	getPathWithName()
KeyTree.Node	getPriority(String path) Get a child from its path.
String	getSideComment()
Object	getValue()
boolean	hasChildren()
boolean	isFirstNode()
boolean	isList()
void	isList(int listSize)
boolean	isRootNode()
Iterator<KeyTree.Node>	iterator()
Set<String>	keys()
void	setComment(String comment)
void	setElementIndex(int elementIndex)
protected void	setPriority(String key, KeyTree.Node child)
void	setSideComment(String sideComment)
int	size()
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

parent

protected final KeyTree.Node parent

name

protected String name

indent

protected int indent

children

protected List<KeyTree.Node> children

indexByName

protected Map<String,KeyTree.Node> indexByName

priorityIndex

protected Map<String,KeyTree.Node> priorityIndex

indexByElementIndex

protected Map<Integer,KeyTree.Node> indexByElementIndex

comment

protected String comment

sideComment

protected String sideComment

isList

protected boolean isList

listSize

protected Integer listSize

elementIndex

protected Integer elementIndex

Method Detail

getName

public String getName()

getComment

public String getComment()

setComment

public void setComment(String comment)

getSideComment

public String getSideComment()

setSideComment

public void setSideComment(String sideComment)

getParent

public KeyTree.Node getParent()

isRootNode

public boolean isRootNode()

isFirstNode

public boolean isFirstNode()

getIndentation

public int getIndentation()

get

protected KeyTree.Node get(String path,
                           boolean add,
                           boolean priority)

Get a child from its path, or optionally add a new one if it is not created.

Parameters:

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

add - if a new node must be added if it does not exist

priority - if true the priority index is used to allow specific repetitions on list values (manually added), otherwise all nodes are allowed (loaded)

Returns:

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

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 KeyTree.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 KeyTree.options() ConfigurationOptions.pathSeparator()

Returns:

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

getElement

protected KeyTree.Node getElement(int i,
                                  boolean add)

Get a child list element from its index, or optionally add a new one if it is not created.

If i is negative then gets the child at index size() + i
Example: node.get(-1) gets the last child of node

Parameters:

i - the index of the child

add - if a new node must be added if it does not exist

Returns:

the child with index i or null if not found and not created

getElement

public KeyTree.Node getElement(int i)

Get a child list element from its index.

If i is negative then gets the child element indexed by size() + i
Example: node.get(-1) gets the last child element of the node list.

Parameters:

i - the index of the child element

Returns:

the child with index i or null if not found

get

public KeyTree.Node get(int i)

Get a child from its index.

If i is negative then gets the child at index size() + i
Example: node.get(-1) gets the last child of node

Parameters:

i - the index of the child

Returns:

the child with index i or null if not found

getFirst

public KeyTree.Node getFirst()

getLast

public KeyTree.Node getLast()

add

public KeyTree.Node add(String key)

add

public KeyTree.Node add(int indent,
                        String key)

add

protected KeyTree.Node add(String key,
                           boolean priority)

add

protected KeyTree.Node add(int indent,
                           String key,
                           boolean priority)

setPriority

protected void setPriority(String key,
                           KeyTree.Node child)

checkList

protected void checkList()

getValue

public Object getValue()

hasChildren

public boolean hasChildren()

children

public List<KeyTree.Node> children()

keys

public Set<String> keys()

entries

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

size

public int size()

isList

public boolean isList()

isList

public void isList(int listSize)

getListSize

public Integer getListSize()

setElementIndex

public void setElementIndex(int elementIndex)

getElementIndex

public Integer getElementIndex()

getPath

public String getPath()

getPathWithName

public String getPathWithName()

clearNode

protected void clearNode()

clearIf

protected boolean clearIf(Predicate<KeyTree.Node> condition,
                          boolean removeFromParent)

clearIf

public boolean clearIf(Predicate<KeyTree.Node> condition)

clear

public void clear()

iterator

public Iterator<KeyTree.Node> iterator()

Specified by:

iterator in interface Iterable<KeyTree.Node>

toString

public String toString()

Overrides:

toString in class Object