Package cc.carm.lib.configuration.source.section

Class ShadedSection

java.lang.Object

cc.carm.lib.configuration.source.section.ShadedSection

All Implemented Interfaces:

ConfigureSection

public class ShadedSection
extends java.lang.Object
implements ConfigureSection

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable ShadedSection	parent
protected @Nullable ConfigureSection	source
protected @NotNull ConfigureSection	template

Constructor Summary

Constructors

Constructor	Description
ShadedSection(@Nullable ShadedSection parent, @NotNull ConfigureSection template, @Nullable ConfigureSection source)

Method Summary

Modifier and Type	Method	Description
@NotNull @UnmodifiableView java.util.Map<java.lang.String,java.lang.Object>	asMap()	Get this section as a map.
static ShadedSection	create(@NotNull ConfigureSection template, @Nullable ConfigureSection source)
@NotNull ConfigureSection	createSection(@NotNull java.lang.String path, @NotNull java.util.Map<?,?> data)	Creates a new ConfigureSection with specified values.
@Nullable java.lang.Object	get(@NotNull java.lang.String path)	Get the origin value of the path.
@Nullable java.lang.Object	getFromTemplate(@NotNull java.lang.String path)
@NotNull @UnmodifiableView java.util.Set<java.lang.String>	getKeys(boolean deep)	Gets a set containing all keys in this section.
@Nullable ConfigureSection	getSource()
@NotNull @UnmodifiableView java.util.Map<java.lang.String,java.lang.Object>	getValues(boolean deep)	Gets a set containing all values in this section.
@Nullable ConfigureSection	parent()	Gets the parent section of this section.
@NotNull java.lang.String	path()	Get the current section's path from ConfigureSection.parent() of this section.
void	remove(@NotNull java.lang.String path)	Removes the value at the given path.
void	set(@NotNull java.lang.String path, @Nullable java.lang.Object value)	Sets the value at the given path.

Methods inherited from class java.lang.Object

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

Methods inherited from interface cc.carm.lib.configuration.source.section.ConfigureSection

childPath, computeSection, computeSection, computeSection, computeSection, contains, containsValue, createSection, createSection, createSection, forEach, fullPath, get, get, get, get, getBoolean, getBoolean, getByte, getByte, getByteList, getChar, getChar, getCharList, getCollection, getDouble, getDouble, getDoubleList, getFloat, getFloat, getFloatList, getInt, getInt, getIntegerList, getList, getList, getLong, getLong, getLongList, getSection, getShort, getShort, getString, getString, getStringList, isBoolean, isByte, isChar, isDouble, isEmpty, isFloat, isInt, isList, isLong, isRoot, isSection, isShort, isString, isType, keys, pathSeparator, size, stream, stream, stream, values

Field Detail

parent

@Nullable
protected final @Nullable ShadedSection parent

template

@NotNull
protected @NotNull ConfigureSection template

source

@Nullable
protected @Nullable ConfigureSection source

Constructor Detail

ShadedSection

public ShadedSection(@Nullable
                     @Nullable ShadedSection parent,
                     @NotNull
                     @NotNull ConfigureSection template,
                     @Nullable
                     @Nullable ConfigureSection source)

Method Detail

create

public static ShadedSection create(@NotNull
                                   @NotNull ConfigureSection template,
                                   @Nullable
                                   @Nullable ConfigureSection source)

parent

@Nullable
public @Nullable ConfigureSection parent()

Description copied from interface: ConfigureSection

Gets the parent section of this section.

For root sections, this will return null.

Specified by:

parent in interface ConfigureSection

Returns:

Parent section, or null if this is a root section.

path

@NotNull
public @NotNull java.lang.String path()

Description copied from interface: ConfigureSection

Get the current section's path from ConfigureSection.parent() of this section.

Specified by:

path in interface ConfigureSection

Returns:

The current path of this section, if ConfigureSection.isRoot(), return empty string.

getValues

@NotNull
public @NotNull @UnmodifiableView java.util.Map<java.lang.String,java.lang.Object> getValues(boolean deep)

Description copied from interface: ConfigureSection

Gets a set containing all values in this section.

If deep is set to true, then this will contain all the keys within any child ConfigureSections (and their children paths).

If deep is set to false, then this will contain only the keys of any direct children, and not their own children.

Specified by:

getValues in interface ConfigureSection

Parameters:

deep - Whether to get a deep list.

Returns:

Map of data values contained within this Section.

asMap

@NotNull
public @NotNull @UnmodifiableView java.util.Map<java.lang.String,java.lang.Object> asMap()

Description copied from interface: ConfigureSection

Get this section as a map.

In this map, child ConfigureSections will also be represented as Maps.

Specified by:

asMap in interface ConfigureSection

Returns:

Map of data values contained within this Section.

getKeys

@NotNull
public @NotNull @UnmodifiableView java.util.Set<java.lang.String> getKeys(boolean deep)

Description copied from interface: ConfigureSection

Gets a set containing all keys in this section.

If deep is set to true, then this will contain all the keys within any child ConfigureSections (and their children paths).

If deep is set to false, then this will contain only the keys of any direct children, and not their own children.

Specified by:

getKeys in interface ConfigureSection

Parameters:

deep - Whether to get a deep list.

Returns:

Set of keys contained within this Section.

set

public void set(@NotNull
                @NotNull java.lang.String path,
                @Nullable
                @Nullable java.lang.Object value)

Description copied from interface: ConfigureSection

Sets the value at the given path.

Null values will be kept, if you want to remove a value use ConfigureSection.remove(String) Path separator depends on holder's StandardOptions.PATH_SEPARATOR

Specified by:

set in interface ConfigureSection

Parameters:

path - The path to set the value at.

value - The value to set.

remove

public void remove(@NotNull
                   @NotNull java.lang.String path)

Description copied from interface: ConfigureSection

Removes the value at the given path.

Path separator depends on holder's StandardOptions.PATH_SEPARATOR

Specified by:

remove in interface ConfigureSection

Parameters:

path - The path to remove the value at.

createSection

@NotNull
public @NotNull ConfigureSection createSection(@NotNull
                                               @NotNull java.lang.String path,
                                               @NotNull
                                               @NotNull java.util.Map<?,?> data)

Description copied from interface: ConfigureSection

Creates a new ConfigureSection with specified values.

The ConfigureSection.parent() of the new section will be this section.

This section will not be saved until ConfigureSection.set(String, Object) is called.

If you want to create and use a section and set it to this section, use ConfigureSection.computeSection(String).

Specified by:

createSection in interface ConfigureSection

data - The data to be used to create section.

Returns:

Newly created section

get

@Nullable
public @Nullable java.lang.Object get(@NotNull
                                      @NotNull java.lang.String path)

Description copied from interface: ConfigureSection

Get the origin value of the path.

Specified by:

get in interface ConfigureSection

Parameters:

path - The path to get the value from.

Returns:

The value at the path, or null if not found.

getFromTemplate

@Nullable
public @Nullable java.lang.Object getFromTemplate(@NotNull
                                                  @NotNull java.lang.String path)

getSource

@Nullable
public @Nullable ConfigureSection getSource()