Package tech.guilhermekaua.spigotboot.config.node

Class YamlConfigNode

java.lang.Object

tech.guilhermekaua.spigotboot.config.node.AbstractValueConfigNode

tech.guilhermekaua.spigotboot.config.node.YamlConfigNode

All Implemented Interfaces:

ConfigNode, MutableConfigNode

public class YamlConfigNode
extends AbstractValueConfigNode
implements MutableConfigNode

YAML-backed implementation of ConfigNode using SnakeYAML.

Constructor Summary

Constructors

Constructor	Description
YamlConfigNode()	Creates a root node.
YamlConfigNode(@Nullable Object data)	Creates a node from existing data.

Method Summary

Modifier and Type	Method	Description
@NotNull MutableConfigNode	appendListItem()	Appends a new item to this list node.
protected @NotNull ConfigNode	createChildNode(@Nullable Object value, @NotNull PropertyPath path, boolean virtual)
protected @NotNull PropertyPath	currentPath()
protected @Nullable Object	currentValue()
protected boolean	currentVirtual()
@NotNull Map<String,List<String>>	getAllChildComments()	Gets all child comments.
@Nullable List<String>	getChildComments(@NotNull String key)	Gets comments for a specific child key.
@Nullable List<String>	getComments()	Gets the comments for this node.
boolean	hasChild(@NotNull Object... pathSegments)	Checks if this node has a child at the given path.
@NotNull MutableConfigNode	node(@NotNull Object... pathSegments)	Navigates to a child node by path segments.
@NotNull ConfigNode	node(@NotNull PropertyPath path)	Navigates to a child node by a property path.
@NotNull MutableConfigNode	remove()	Removes this node from its parent.
@NotNull MutableConfigNode	set(@Nullable Object newValue)	Sets the value of this node.
@NotNull MutableConfigNode	setComment(@Nullable String... lines)	Sets a comment for this node (if supported by the format).

Methods inherited from class tech.guilhermekaua.spigotboot.config.node.AbstractValueConfigNode

childrenList, childrenMap, get, get, isList, isMap, isNull, isScalar, isVirtual, path, raw

Methods inherited from class java.lang.Object

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

Methods inherited from interface tech.guilhermekaua.spigotboot.config.node.ConfigNode

childrenList, childrenMap, get, get, isList, isMap, isNull, isScalar, isVirtual, path, raw

Constructor Details

YamlConfigNode

public YamlConfigNode()

Creates a root node.

YamlConfigNode

public YamlConfigNode(@Nullable
 @Nullable Object data)

Creates a node from existing data.

Parameters:

data - the raw data

Method Details

currentValue

@Nullable
protected @Nullable Object currentValue()

Specified by:

currentValue in class AbstractValueConfigNode

currentPath

@NotNull
protected @NotNull PropertyPath currentPath()

Specified by:

currentPath in class AbstractValueConfigNode

currentVirtual

protected boolean currentVirtual()

Specified by:

currentVirtual in class AbstractValueConfigNode

createChildNode

@NotNull
protected @NotNull ConfigNode createChildNode(@Nullable
 @Nullable Object value,
 @NotNull
 @NotNull PropertyPath path,
 boolean virtual)

Specified by:

createChildNode in class AbstractValueConfigNode

node

@NotNull
public @NotNull MutableConfigNode node(@NotNull
 @NotNull Object... pathSegments)

Description copied from interface: ConfigNode

Navigates to a child node by path segments.

If the path doesn't exist, returns a virtual (empty) node.

Specified by:

node in interface ConfigNode

Specified by:

node in interface MutableConfigNode

Overrides:

node in class AbstractValueConfigNode

Parameters:

pathSegments - the path segments (strings for map keys, integers for list indices)

Returns:

the child node, never null

node

@NotNull
public @NotNull ConfigNode node(@NotNull
 @NotNull PropertyPath path)

Description copied from interface: ConfigNode

Navigates to a child node by a property path.

If the path doesn't exist, returns a virtual (empty) node.

Specified by:

node in interface ConfigNode

Specified by:

node in interface MutableConfigNode

Overrides:

node in class AbstractValueConfigNode

Parameters:

path - the PropertyPath to navigate to

Returns:

the child node, never null

hasChild

public boolean hasChild(@NotNull
 @NotNull Object... pathSegments)

Description copied from interface: ConfigNode

Checks if this node has a child at the given path.

Specified by:

hasChild in interface ConfigNode

Overrides:

hasChild in class AbstractValueConfigNode

Parameters:

pathSegments - the path segments

Returns:

true if the child exists and is not virtual

set

@NotNull
public @NotNull MutableConfigNode set(@Nullable
 @Nullable Object newValue)

Description copied from interface: MutableConfigNode

Sets the value of this node.

Specified by:

set in interface MutableConfigNode

Parameters:

newValue - the value to set, or null to clear

Returns:

this node for chaining

setComment

@NotNull
public @NotNull MutableConfigNode setComment(@Nullable
 @Nullable String... lines)

Description copied from interface: MutableConfigNode

Sets a comment for this node (if supported by the format).

Specified by:

setComment in interface MutableConfigNode

Parameters:

lines - the comment lines, or null to remove

Returns:

this node for chaining

getComments

@Nullable
public @Nullable List<String> getComments()

Gets the comments for this node.

Returns:

the comments, or null

getChildComments

@Nullable
public @Nullable List<String> getChildComments(@NotNull
 @NotNull String key)

Gets comments for a specific child key.

Parameters:

key - the child key

Returns:

the comments, or null

getAllChildComments

@NotNull
public @NotNull Map<String,List<String>> getAllChildComments()

Gets all child comments.

Returns:

map of key to comment lines

remove

@NotNull
public @NotNull MutableConfigNode remove()

Description copied from interface: MutableConfigNode

Removes this node from its parent.

Specified by:

remove in interface MutableConfigNode

Returns:

this node for chaining

appendListItem

@NotNull
public @NotNull MutableConfigNode appendListItem()

Description copied from interface: MutableConfigNode

Appends a new item to this list node.

If this node is not a list, it will be converted to one.

Specified by:

appendListItem in interface MutableConfigNode

Returns:

the new list item node