vital-configs/dev.vitalframework.configs/VitalConfig

VitalConfig

abstract class VitalConfig : VitalHasInfo

Defines a config within the Vital-Framework. A config class defines the structure and datatypes of a singular configuration file stored on the filesystem. It's data can be loaded from the filesystem into the class to expose a developer-friendly api to access it.

Each field annotated with VitalConfig.Property will be defined as a valid property for serialization and deserialization.

The consuming class must be annotated with VitalConfig.Info.

@VitalConfig.Info(
  name = "my-vital-config.yaml",
  processor = VitalYAMLConfigProcessor.class
)
public class MyVitalConfig extends VitalConfig {
  @Property(types = {String.class})
  private String myString;

  @Property(types = {String.class})
  private List<String> myStringList;

  @Property(types = {String.class, Long.class})
  private Map<String, Long> myStringLongMap;
}

Constructors

VitalConfig

constructor()

Types

Companion

object Companion

Info

@Component

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Info(val name: String, val processor: KClass<out VitalConfig.Processor<*, Any>>)

Defines the info for a VitalConfig.

Processor

interface Processor<S, out T>

Defines a processor that can serialize and deserialize content for a VitalConfig. Implementation classes should be used in Info.processor.

Property

@Target(allowedTargets = [AnnotationTarget.FIELD])

annotation class Property(val types: KClass<*>)

This annotation marks a Field as a property that can automatically be injected by a VitalConfig. Use this annotation inside a VitalConfig implementer or any other class than is used as a value in a VitalConfig implementer.

Properties

file

val file: Path

info

open override val info: MutableMap<Class<VitalConfig.Info>, VitalConfig.Info>

logger

val logger: Logger

processor

val processor: VitalConfig.Processor<*, Any>

Functions

getInfo

open fun <T : Annotation> getInfo(type: Class<T>): T

load

fun load(inputStream: InputStream)

Loads this config from the given inputStream. This function will load the serialized content via the defined Info.processor and initialize this class's fields.

save

fun save()

Saves this config by writing its field values to the defined file in path Info.name.