Package space.arim.dazzleconf

Interface ConfigurationDefinition.ReadOptions

All Superinterfaces:
UpdateListener
All Known Subinterfaces:
ConfigurationDefinition.ReadWithUpdateOptions, DeserializeContext, DeserializeInput
Enclosing interface:
ConfigurationDefinition<C>
public static interface ConfigurationDefinition.ReadOptions extends UpdateListener
Parameters for reading a configuration from a tree

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull KeyMapper
    keyMapper()
    The key mapper to use
    @NonNull KeyPath
    keyPath()
    Gets the absolute key path at which the configuration is being read.
    default int
    maximumErrorCollect()
    The maximum number of errors to collect before exiting.

    Methods inherited from interface space.arim.dazzleconf.engine.UpdateListener

    notifyUpdate

  • Method Details

    • keyMapper

      @NonNull KeyMapper keyMapper()
      The key mapper to use
      Returns:
      the key mapper

    • keyPath

      @NonNull KeyPath keyPath()
      Gets the absolute key path at which the configuration is being read.

      This path is intended as a debug value and might be used in error messages, such as by using it to prefi sub-paths within this configuration. The implementor of this method can return an empty path to represent the root configuration or if the path prefix is unknown.

      Returns:
      the path at which the configuration is read, or an empty KeyPath if none. It is recommended to return a KeyPath.Immut, since the caller might modify this return value

    • maximumErrorCollect

      default int maximumErrorCollect()
      The maximum number of errors to collect before exiting. Must be greater than 0.

      If reading the configuration failed, the size of LoadResult.getErrorContexts() will be at most this number.

      Returns:
      the maximum number of errors to collect, default 12. Must be greater than 0