Package com.saicone.settings.node

Class NodeValue<V>

java.lang.Object

com.saicone.settings.node.NodeValue<V>

Type Parameters:

V - the value type of the node.

All Implemented Interfaces:

SettingsNode, com.saicone.types.ValueType<Object>

Direct Known Subclasses:

NodeKey

public abstract class NodeValue<V>
extends Object
implements SettingsNode

Abstract class that represents a node multi-layer value along with comments.
Any type transformation will be cached.

Constructor Summary

Constructors

Constructor	Description
NodeValue(V value)	Constructs a node value with the given object.

Method Summary

Modifier and Type	Method	Description
<E> E	as(@NotNull com.saicone.types.TypeParser<E> parser, E def)
<E> E	as(@NotNull Class<E> type, E def)
<E,C extends Collection<E>> C	asCollection(@NotNull com.saicone.types.TypeParser<E> parser, C collection)
<E extends Enum<?>> E	asEnum(@NotNull Class<E> type)
<E extends Enum<?>> E	asEnum(@NotNull Class<E> type, @NotNull E[] values)
<E> @NotNull Optional<E>	asOptional(@NotNull com.saicone.types.TypeParser<E> parser)
boolean	equals(Object object)
@Nullable Object	getFaceValue()	Get the facing value inside the node.
@Nullable List<String>	getSideComment()	Get side comment from the node.
@Nullable Object	getSourceValue()	Get the value that will be used to save this node.
@Nullable List<String>	getTopComment()	Get top comment from the node.
V	getValue()
int	hashCode()
boolean	hasSideComment()	Check if the current node has any side comment.
boolean	hasTopComment()	Check if the current node has any top comment.
static @NotNull SettingsNode	of(@Nullable Object object)	Create a node value with the given object.
@NotNull SettingsNode	setSideComment(@Nullable List<String> sideComment)	Replace the node side comment.
@NotNull SettingsNode	setSourceValue(@Nullable Object value)	Replace the actual source value.
@NotNull SettingsNode	setTopComment(@Nullable List<String> topComment)	Replace the node top comment.
@NotNull SettingsNode	setValue(@NotNull Object value)	Set the value that will be return on ValueType.getValue() and change this node instance depending on actual value. If source value is not set will be replaced.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.saicone.settings.SettingsNode

addSideComment, addTopComment, asListNode, asLiteralObject, asMapNode, asObjectNode, copy, copy, copy, delete, delete, edit, edit, getKey, getParent, getRoot, isList, isMap, isObject, isReal, isRoot, merge, mergeComment, move, parse, parse, replaceArgs, replaceArgs, setKey, setParent

Methods inherited from interface com.saicone.types.ValueType

as, as, asArray, asArray, asArray, asBoolean, asBoolean, asByte, asByte, asChar, asChar, asDouble, asDouble, asFloat, asFloat, asInt, asInt, asList, asLong, asLong, asMap, asNumber, asNumber, asSet, asShort, asShort, asString, asString, asUniqueId, asUniqueId

Constructor Detail

NodeValue

public NodeValue(@Nullable
                 V value)

Constructs a node value with the given object.

Parameters:

value - the value of the node.

Method Detail

of

@NotNull
public static @NotNull SettingsNode of(@Nullable
                                       @Nullable Object object)

Create a node value with the given object.

Parameters:

object - the object to wrap as node value.

Returns:

a settings node that represents the node value.

hasTopComment

public boolean hasTopComment()

Description copied from interface: SettingsNode

Check if the current node has any top comment.

Specified by:

hasTopComment in interface SettingsNode

Returns:

true if the node contains a top comment.

hasSideComment

public boolean hasSideComment()

Description copied from interface: SettingsNode

Check if the current node has any side comment.

Specified by:

hasSideComment in interface SettingsNode

Returns:

true if the node contains a side comment.

getValue

public V getValue()

Specified by:

getValue in interface com.saicone.types.ValueType<V>

getFaceValue

@Nullable
public @Nullable Object getFaceValue()

Get the facing value inside the node.

Returns:

the value that was set after node creation, null otherwise.

getSourceValue

@Nullable
public @Nullable Object getSourceValue()

Description copied from interface: SettingsNode

Get the value that will be used to save this node.

Specified by:

getSourceValue in interface SettingsNode

Returns:

a saved source value, null otherwise.

getTopComment

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

Description copied from interface: SettingsNode

Get top comment from the node.

Specified by:

getTopComment in interface SettingsNode

Returns:

a comment if is set, null otherwise.

getSideComment

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

Description copied from interface: SettingsNode

Get side comment from the node.

Specified by:

getSideComment in interface SettingsNode

Returns:

a comment if is set, null otherwise.

setValue

@NotNull
public @NotNull SettingsNode setValue(@NotNull
                                      @NotNull Object value)

Description copied from interface: SettingsNode

Set the value that will be return on ValueType.getValue() and change this node instance depending on actual value.
If source value is not set will be replaced.

Specified by:

setValue in interface SettingsNode

Parameters:

value - the value to set.

Returns:

the effective node in this operation, normally this node.

setSourceValue

@NotNull
public @NotNull SettingsNode setSourceValue(@Nullable
                                            @Nullable Object value)

Description copied from interface: SettingsNode

Replace the actual source value.

Specified by:

setSourceValue in interface SettingsNode

Parameters:

value - the source value to set.

Returns:

the effective node in this operation, normally this node.

setTopComment

@NotNull
public @NotNull SettingsNode setTopComment(@Nullable
                                           @Nullable List<String> topComment)

Description copied from interface: SettingsNode

Replace the node top comment.

Specified by:

setTopComment in interface SettingsNode

Parameters:

topComment - the comment to set.

Returns:

the effective node in this operation, normally this node.

setSideComment

@NotNull
public @NotNull SettingsNode setSideComment(@Nullable
                                            @Nullable List<String> sideComment)

Description copied from interface: SettingsNode

Replace the node side comment.

Specified by:

setSideComment in interface SettingsNode

Parameters:

sideComment - the comment to set.

Returns:

the effective node in this operation, normally this node.

as

@Nullable
public <E> E as(@NotNull
                @NotNull Class<E> type,
                @Nullable
                E def)

Specified by:

as in interface com.saicone.types.ValueType<V>

as

@Nullable
public <E> E as(@NotNull
                @NotNull com.saicone.types.TypeParser<E> parser,
                @Nullable
                E def)

Specified by:

as in interface com.saicone.types.ValueType<V>

asOptional

@NotNull
public <E> @NotNull Optional<E> asOptional(@NotNull
                                           @NotNull com.saicone.types.TypeParser<E> parser)

Specified by:

asOptional in interface com.saicone.types.ValueType<V>

asCollection

@NotNull
public <E,C extends Collection<E>> C asCollection(@NotNull
                                                        @NotNull com.saicone.types.TypeParser<E> parser,
                                                        @NotNull
                                                        C collection)

Specified by:

asCollection in interface com.saicone.types.ValueType<V>

asEnum

@Nullable
public <E extends Enum<?>> E asEnum(@NotNull
                                    @NotNull Class<E> type)

Specified by:

asEnum in interface com.saicone.types.ValueType<V>

asEnum

@Nullable
public <E extends Enum<?>> E asEnum(@NotNull
                                    @NotNull Class<E> type,
                                    @NotNull
                                    @NotNull E[] values)

Specified by:

asEnum in interface com.saicone.types.ValueType<V>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object