Package com.kamikazejam.kamicommon.yaml.source

Class StringConfigSource

java.lang.Object

com.kamikazejam.kamicommon.yaml.source.StringConfigSource

All Implemented Interfaces:

ConfigSource

public class StringConfigSource
extends Object
implements ConfigSource

A ConfigSource implementation that reads from a predefined yaml string in memory.

Supports ONLY read operations. Writes unsupported as the source is an immutable string.
Does NOT support defaults via a resource stream.

Source string can be any string parsable by snake-yaml, like the contents of a yaml file.

Constructor Summary

Constructors

Constructor	Description
StringConfigSource(@NotNull String content)	Construct a config source with the provided yaml content string. See StringConfigSource(@org.jetbrains.annotations.NotNull java.lang.String,@org.jetbrains.annotations.Nullable java.lang.String) for adding a custom ID for logging/debugging.
StringConfigSource(@NotNull String content, @Nullable String id)

Method Summary

Modifier and Type	Method	Description
@Nullable String	getResourceStreamPath()	Returns the path to a resource stream for default configuration data, if available. This is typically used to load default settings bundled with the application/plugin. If no resource stream is associated, may return null.
@NotNull String	id()	A human-readable identifier for this source (e.g., absolute file path, URL, logical name). Uniqueness is not required and the value is intended primarily for logging/debugging.
@NotNull Optional<InputStream>	openStream()	Opens a fresh InputStream for the current contents of this source. The caller is responsible for closing the returned stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kamikazejam.kamicommon.yaml.source.ConfigSource

asFileIfPresent, ensureExistsIfWritable, isWritable, write

Constructor Details

StringConfigSource

public StringConfigSource(@NotNull
 @NotNull String content)

Construct a config source with the provided yaml content string.
See StringConfigSource(@org.jetbrains.annotations.NotNull java.lang.String,@org.jetbrains.annotations.Nullable java.lang.String) for adding a custom ID for logging/debugging.

StringConfigSource

public StringConfigSource(@NotNull
 @NotNull String content,
 @Nullable
 @Nullable String id)

Method Details

id

@NotNull
public @NotNull String id()

Description copied from interface: ConfigSource

A human-readable identifier for this source (e.g., absolute file path, URL, logical name).
Uniqueness is not required and the value is intended primarily for logging/debugging.

Specified by:

id in interface ConfigSource

Returns:

identifier string for this source (not necessarily unique)

openStream

@NotNull
public @NotNull Optional<InputStream> openStream()

Description copied from interface: ConfigSource

Opens a fresh InputStream for the current contents of this source.
The caller is responsible for closing the returned stream.

Specified by:

openStream in interface ConfigSource

Returns:

an Optional containing a new InputStream if content is available; empty if absent

getResourceStreamPath

@Nullable
public @Nullable String getResourceStreamPath()

Description copied from interface: ConfigSource

Returns the path to a resource stream for default configuration data, if available.
This is typically used to load default settings bundled with the application/plugin.

If no resource stream is associated, may return null.

Specified by:

getResourceStreamPath in interface ConfigSource