org.deephacks.tools4j.config.query.ConfigQuery Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tools4j-config Show documentation

Tools4j Config

There is a newer version: 0.15.0

package org.deephacks.tools4j.config.query;


import org.deephacks.tools4j.config.query.ConfigQueryBuilder.Restriction;

/**
 * Used for retrieving configurable instances by composing Criterion
 * objects that scan indexed fields.
 *
 * {@link ConfigQueryBuilder} is used to compose SQL-like queries together with
 * this object.
 *
 * This feature is currently experimental and must be turned on by setting
 * System Property 'typesafe.query.enabled' to true.
 *
 * @see {@link ConfigQueryBuilder}
 */
public interface ConfigQuery {
    /**
     * Add another criterion on this query. This is treated as a logical AND operation
     * with regards to the already composed query.
     *
     * @param restriction a restriction on the query.
     * @return ConfigQuery
     */
    public abstract ConfigQuery add(Restriction restriction);

    /**
     * Execute the query and retrieve a lazy evaluated result set.
     *
     * @return result set.
     */
    public ConfigResultSet retrieve();

}