Package io.github.ttno1.configvalidation

package io.github.ttno1.configvalidation
  • Class
    Description
    BaseType
     
    Cfg
    Factory class for creating ConfigNodes, ConfigLists, and ConfigSpecs.
    Cfg.List
     
    Cfg.Node
     
    CheckedConsumer<T, E extends Throwable>
    Identical to Consumer except that the CheckedConsumer.accept(Object) method may throw a checked exception.
    ConfigFilter<T,U>
    A functional interface for functions that validate config input and optionally convert it to a new output type.
    ConfigFilters are intended to be chained together with ConfigFilter.withFilter(ConfigFilter).
    See ConfigFilterResult for information on the return type of this function.
    ConfigFilterResult<T>
    Represents the result of a ConfigFilter.
    Specifies whether it passed or failed, the output if it passed, and the fail message if it failed.
    ConfigFilters
    Utility class with methods that provide common ConfigFilters.
    ConfigFilters.FileState
    Represents the state of a file on the file system.
    ConfigList<T,U,V>
    Represents a list of elements that should exist in a configuration.
    Specifies a data type, a filter, and an element filter that a list node should match.
    The element filter is applied to each element separately to produce a list of type U and the filter is applied to the List<U> produced by applying the element filter to the input.
    When a list is validated against a ConfigWrapper, the type of the list is verified to be correct and both filters are confirmed to have passed.
    ConfigNode<T,U>
    Represents a node that should exist in a configuration.
    Specifies a data type and a filter that a configuration node should match.
    When a node is validated against a ConfigWrapper, the type of the node is verified to be correct and the filter is confirmed to have passed.
    ConfigSpec<U>
    A Configuration Specification that specifies various ConfigNodes that must be present in a configuration.
    This class is used to validate a config with many nodes.
    Specifies list of nodes and their corresponding locations (paths) in the configuration.
    When a ConfigSpec is validated against a ConfigWrapper, each of its contained nodes are validated as well.
    ConfigValidationResult
    Represents the result of a config validation operation.
    Specifies whether it passed or failed and a fail message if it failed.
    ConfigWrapper
    Abstraction over config classes from many libraries.
    If the underlying config does not contain a value at a given path, the get methods in this interface return null.
    If any arguments of any method are null, the methods of this interface may throw a NullPointerException.
    The ConfigWrapper.getConfigSubsection(String) method called with an empty string as the argument should return a ConfigWrapper equal to this, ConfigWrapper.isConfigSubsection(String) with an empty string should return true, and ConfigWrapper.containsNode(String) with an empty string should return true.