uk.autores.handling.ConfigDef Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of annotations Show documentation

Annotation driven library for handling embedded resources

There is a newer version: 11.0.35-beta

// Copyright 2023 https://github.com/autores-uk/autores/blob/main/LICENSE.txt
// SPDX-License-Identifier: Apache-2.0
package uk.autores.handling;

import java.util.function.Predicate;

import static java.util.Objects.requireNonNull;

/**
 * Defines the configuration supported by a {@link Handler}.
 *
 * @see Handler#config()
 */
public final class ConfigDef {

    private final String key;
    private final Predicate validator;

    /**
     * Ctor.
     *
     * @param key the config key
     * @param validator must return true if the value is valid or false otherwise
     */
    public ConfigDef(String key, Predicate validator) {
        this.key = requireNonNull(key, "name");
        this.validator = requireNonNull(validator, "validator");
    }

    /**
     * Configuration key.
     *
     * @return config key name
     * @see ResourceFiles.Cfg#key()
     * @see Config#key()
     */
    public String key() {
        return key;
    }

    /**
     * Tests validity of value.
     *
     * @param value the value to test
     * @return true if the value is valid or false otherwise
     * @see ResourceFiles.Cfg#value()
     * @see Config#value()
     */
    public boolean isValid(String value) {
        return validator.test(value);
    }
}