Module io.jstach.ezkv.kvs

Package io.jstach.ezkv.kvs

Interface KeyValuesEnvironment

public interface KeyValuesEnvironment

A facade over various system-level singletons used for loading key-value resources. This interface provides a flexible mechanism for accessing and overriding system-level components such as environment variables, system properties, and input streams.

Implementations can replace default system behaviors, enabling custom retrieval of environment variables or properties, or integrating custom logging mechanisms.

API Note

The API in this class uses traditional getter methods because the methods are often dynamic and to be consistent with the methods they are facading.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	KeyValuesEnvironment.Logger	Key Values Resource focused logging facade and event capture.
static interface	KeyValuesEnvironment.ResourceLoader	Interface for loading resources.

Method Summary

Modifier and Type	Method	Description
default KeyValuesResource	defaultResource()	If the loader builder is not passed any resources this resource will be used.
default ClassLoader	getClassLoader()	Retrieves the class loader.
default @Nullable Path	getCWD()	Gets the current working directory possibly using the passed in filesystem.
default FileSystem	getFileSystem()	Retrieves the FileSystem used for loading file resources.
default KeyValuesEnvironment.Logger	getLogger()	Retrieves the logger instance used for logging messages.
default @NonNull String[]	getMainArgs()	Retrieves the main method arguments.
default Random	getRandom()	Retrieves a random number generator.
default KeyValuesEnvironment.ResourceLoader	getResourceLoader()	Retrieves the KeyValuesEnvironment.ResourceLoader used for loading resources as streams.
default InputStream	getStandardInput()	Retrieves the standard input stream.
default Map<String,String>	getSystemEnv()	Retrieves the current environment variables.
default Properties	getSystemProperties()	Retrieves the current system properties.

Method Details

defaultResource

default KeyValuesResource defaultResource()

If the loader builder is not passed any resources this resource will be used.

Returns:

default resource is classpath:/boot.properties

getMainArgs

default @NonNull String[] getMainArgs()

Retrieves the main method arguments. By default, returns an empty array.

Returns:

an array of main method arguments

getSystemProperties

default Properties getSystemProperties()

Retrieves the current system properties. By default, delegates to System.getProperties().

Returns:

the current system properties

getSystemEnv

default Map<String,String> getSystemEnv()

Retrieves the current environment variables. By default, delegates to System.getenv().

Returns:

a map of environment variables

getRandom

default Random getRandom()

Retrieves a random number generator. By default, returns a new Random instance.

Returns:

random.

getStandardInput

default InputStream getStandardInput()

Retrieves the standard input stream. By default, delegates to System.in.

Returns:

the standard input stream or an empty input stream if System.in is null

getLogger

default KeyValuesEnvironment.Logger getLogger()

Retrieves the logger instance used for logging messages. By default, returns a noop logger.

Returns:

the logger instance

getResourceLoader

default KeyValuesEnvironment.ResourceLoader getResourceLoader()

Retrieves the KeyValuesEnvironment.ResourceLoader used for loading resources as streams.

Returns:

the resource stream loader instance

getFileSystem

default FileSystem getFileSystem()

Retrieves the FileSystem used for loading file resources.

Returns:

by default FileSystems.getDefault().

getCWD

default @Nullable Path getCWD()

Gets the current working directory possibly using the passed in filesystem.

Returns:

cwd or null

getClassLoader

default ClassLoader getClassLoader()

Retrieves the class loader. By default, delegates to ClassLoader.getSystemClassLoader().

Returns:

the system class loader