io.nosqlbench.nb.api.config.params.ConfigSource 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.params;

import java.util.List;

/**
 * A Config Source knows how to read a block of data and convert it
 * into a stream of zero or more configuration elements.
 */
public interface ConfigSource {

    /**
     * Test the input data format to see if it appears valid for reading
     * with this config source.
     *
     * @param source An object of any kind
     * @return true if the text is parsable by this config source
     */
    boolean canRead(Object source);

    /**
     * Read the source of data into a collection of config elements
     *
     * @param source An object of any kind
     * @return a collection of {@link Element}s
     */
    List getAll(Object source);

//    ElementData getOneElementData(Object src);
}