vital-configs/dev.vitalframework.configs.processor/VitalPropertiesConfigProcessor

VitalPropertiesConfigProcessor

class VitalPropertiesConfigProcessor : VitalConfig.Processor<Properties, String>

File processor for VitalConfig instances that want to store data in a .properties file. Define this processor in VitalConfig.Info to use it.

@VitalConfig.Info(name = "myconfig.properties", processor = VitalPropertiesConfigProcessor.class)
public class MyPropertiesConfig extends VitalConfig {
}

Constructors

constructor()

Properties

data

open override val data: Properties

The data object this processor will use to serialize the content. E.g., java.util.Properties for a processor that can write and load .properties configs.

Functions

deserialize

open override fun deserialize(serializedContent: Map<String, String>, type: Class<*>): Any?

Deserializes the given serializedContent to the given type returns an initialized instance of it.

load

open override fun load(inputStream: InputStream, clazz: Class<*>): Map<String, String>

Loads the given inputStream into the data of this config and returns a Map of all properties to value mappings.

read

open override fun read(key: String): String?

Reads a single value for the given key from the data of this config.

open override fun read(key: String, def: String): String?

Reads a single value for the given key from the data of this config. If no value was found, this function will return the given def.

save

open override fun save(serializedContent: Map<String, String>): String

Saves the given serializedContent to the data of this config.

serialize

open override fun serialize(instance: Any): Map<String?, String>

Serializes the content of the given instance to a Map where each entry is the name and value for each Field of the given instance.

write

open override fun write(instance: Any)

Writes the given instance to the file of this config. E.g., the VitalPropertiesConfigProcessor first serialized its content via serialize and then calls write with it.

open override fun write(serializedContent: Map<String, String>)

Writes the given serializedContent to the file of this config.

open override fun write(key: String, value: String)

Writes the given value to the property with the given key to the data of this config.