io.nosqlbench.nb.api.config.fieldreaders.StaticFieldReader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nb-api Show documentation

The top level API module for NoSQLBench. This module should have no internal module dependencies other than the mvn-default module. All modules within NoSQLBench can safely depend on this module with circular dependencies. This module provides cross-cutting code infrastracture, such as path utilities and ways of describing services used between modules. It is also the transitive aggregation point for system-wide library dependencies for logging and testing or similar needs.

There is a newer version: 5.17.0

Show newest version

package io.nosqlbench.nb.api.config.fieldreaders;

import java.util.Optional;

public interface StaticFieldReader {

    /**
     * @param field The requested field name
     * @return true, if the field is defined.
     */
    boolean isDefined(String field);

    /**
     * @param field The requested field name
     * @param type The required type of the field value
     * @return true if the field is defined and its value is statically defined as assignable to the given type
     */
    boolean isDefined(String field, Class type);

    /**
     * @param fields The requested field names
     * @return true if the field names are all defined
     */
    boolean isDefined(String... fields);

     T getStaticValue(String field, Class classOfT);

     T getStaticValue(String field);

     T getStaticValueOr(String name, T defaultValue);

     Optional getOptionalValue(String field, Class classOfT);

    void assertDefinedStatic(String... fields);
}