Package dev.satyrn.papermc.api.configuration.v1

Class OptionalConfigurationNode<T>

java.lang.Object

dev.satyrn.papermc.api.configuration.v1.ConfigurationNode<Optional<T>>

dev.satyrn.papermc.api.configuration.v1.OptionalConfigurationNode<T>

Type Parameters:

T - The type of the configuration node.

public abstract class OptionalConfigurationNode<T>
extends ConfigurationNode<Optional<T>>

A configuration node

Since:

1.9.1

Author:

Isabel Maskrey

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OptionalConfigurationNode(@NotNull ConfigurationNode<?> parent, @Nullable String name)	Initializes a new Configuration node.

Method Summary

Modifier and Type	Method	Description
@NotNull Optional<T>	defaultValue()	Gets the default value of the node.
abstract T	getActualValue()	Gets the underlying value of the node.
void	save()	Writes the value of the node to the config file.
final @NotNull Optional<T>	value()	Gets the value of the node.

Methods inherited from class dev.satyrn.papermc.api.configuration.v1.ConfigurationNode

addChild, equals, getBasePath, getBasePath, getChildren, getComments, getComments, getConfig, getInlineComments, getInlineComments, getLogger, getName, getPath, getPath, getPlugin, getPriority, getSLF4JLogger, getValueNodeName, getValuePath, getValuePath, hasChildren, hasName, isSubNode, setComments, setComments, setConfigValue, setInlineComments, setInlineComments, setValue, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

OptionalConfigurationNode

protected OptionalConfigurationNode(@NotNull
 @NotNull ConfigurationNode<?> parent,
 @Nullable
 @Nullable String name)

Initializes a new Configuration node.

Parameters:

parent - The parent node.

name - The node name.

Since:

1.9.1

Method Details

value

@NotNull
public final @NotNull Optional<T> value()

Gets the value of the node.

Specified by:

value in class ConfigurationNode<Optional<T>>

Returns:

The value.

Since:

1.9.1

defaultValue

@NotNull
public @NotNull Optional<T> defaultValue()

Gets the default value of the node.

Specified by:

defaultValue in class ConfigurationNode<Optional<T>>

Returns:

The default value.

Since:

1.9.1

getActualValue

@Nullable
public abstract T getActualValue()

Gets the underlying value of the node.

Returns:

The actual value of the node.

Since:

1.9.1

save

public void save()

Writes the value of the node to the config file.

Overrides:

save in class ConfigurationNode<Optional<T>>

Since:

1.9.1