Package com.kamikazejam.kamicommon.yaml

Class AbstractYamlHandler<T extends AbstractYamlConfiguration>

java.lang.Object

com.kamikazejam.kamicommon.yaml.AbstractYamlHandler<T>

Direct Known Subclasses:

YamlHandlerStandalone

public abstract class AbstractYamlHandler<T extends AbstractYamlConfiguration>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final @NotNull AbstractConfig<?>	abstractConfig
T	config
final @Nullable Supplier<InputStream>	defaultsStream
final @NotNull ConfigSource	source

Constructor Summary

Constructors

Constructor	Description
AbstractYamlHandler(@NotNull AbstractConfig<?> abstractConfig, @NotNull ConfigSource source, @Nullable Supplier<InputStream> defaultsStream)

Method Summary

Modifier and Type	Method	Description
static @NotNull org.yaml.snakeyaml.nodes.MappingNode	createNewMappingNode()
abstract void	error(String s)
T	loadConfig()
abstract T	newConfig(@NotNull org.yaml.snakeyaml.nodes.MappingNode node, @NotNull ConfigSource source)
abstract @NotNull MemorySectionMethods<?>	newMemorySection(@NotNull org.yaml.snakeyaml.nodes.MappingNode node)
boolean	save()	Saves the config to the file
abstract void	warn(String s)

Methods inherited from class java.lang.Object

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

Field Details

abstractConfig

@NotNull
public final @NotNull AbstractConfig<?> abstractConfig

source

@NotNull
public final @NotNull ConfigSource source

defaultsStream

@Nullable
public final @Nullable Supplier<InputStream> defaultsStream

config

@Nullable
public T extends AbstractYamlConfiguration config

Constructor Details

AbstractYamlHandler

public AbstractYamlHandler(@NotNull
 @NotNull AbstractConfig<?> abstractConfig,
 @NotNull
 @NotNull ConfigSource source,
 @Nullable
 @Nullable Supplier<InputStream> defaultsStream)

Parameters:

abstractConfig - The parent config instance who holds this handler.

source - The source of the configuration file (yaml content).

defaultsStream - An optional stream (of a YAML config) to read default values from, can be null.

Method Details

newConfig

@NotNull
public abstract T newConfig(@NotNull
 @NotNull org.yaml.snakeyaml.nodes.MappingNode node,
 @NotNull
 @NotNull ConfigSource source)

newMemorySection

@NotNull
public abstract @NotNull MemorySectionMethods<?> newMemorySection(@NotNull
 @NotNull org.yaml.snakeyaml.nodes.MappingNode node)

error

public abstract void error(String s)

warn

public abstract void warn(String s)

loadConfig

@NotNull
public T loadConfig()

save

@Internal
public boolean save()

Saves the config to the file

Returns:

true IFF the config was saved successfully (can be skipped if the config is not changed)

createNewMappingNode

@NotNull
public static @NotNull org.yaml.snakeyaml.nodes.MappingNode createNewMappingNode()