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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AbstractYamlHandler.NodePair

Field Summary

Fields

Modifier and Type	Field	Description
protected final AbstractConfig<?>	abstractConfig
protected T	config
protected final File	configFile
protected final @Nullable Supplier<InputStream>	defaultsStream
protected final String	fileName

Constructor Summary

Constructors

Constructor	Description
AbstractYamlHandler(AbstractConfig<?> abstractConfig, File configFile, @Nullable Supplier<InputStream> defaultsStream)

Method Summary

Modifier and Type	Method	Description
static void	copyCommentsFromDefault(AbstractYamlConfiguration config, List<AbstractYamlHandler.NodePair> keyNodes, boolean defOverwrites)
static org.yaml.snakeyaml.nodes.MappingNode	createNewMappingNode()
abstract void	error(String s)
T	loadConfig()
abstract T	newConfig(org.yaml.snakeyaml.nodes.MappingNode node, File configFile)
abstract MemorySectionMethods<?>	newMemorySection(org.yaml.snakeyaml.nodes.MappingNode node)
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

protected final AbstractConfig<?> abstractConfig

configFile

protected final File configFile

fileName

protected final String fileName

defaultsStream

@Nullable
protected final @Nullable Supplier<InputStream> defaultsStream

config

protected T extends AbstractYamlConfiguration config

Constructor Details

AbstractYamlHandler

public AbstractYamlHandler(AbstractConfig<?> abstractConfig,
 File configFile,
 @Nullable
 @Nullable Supplier<InputStream> defaultsStream)

Parameters:

abstractConfig - The parent config instance who holds this handler.

configFile - The file to read/write the configuration to/from.

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

Method Details

newConfig

public abstract T newConfig(org.yaml.snakeyaml.nodes.MappingNode node,
 File configFile)

newMemorySection

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

loadConfig

@NotNull
public T loadConfig()

createNewMappingNode

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

error

public abstract void error(String s)

warn

public abstract void warn(String s)

copyCommentsFromDefault

public static void copyCommentsFromDefault(AbstractYamlConfiguration config,
 List<AbstractYamlHandler.NodePair> keyNodes,
 boolean defOverwrites)

Parameters:

config - The config to copy comments to

keyNodes - NodePairs of the keys to copy comments from