io.nosqlbench.nb.api.content.URIResolvers 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.content;

/**
 * This is a URI-centric content locator for URLs and Paths. This central
 * API is meant to make dealing with content bundling and loading easy,
 * given how convoluted using the standard APIs can be.
 *
 * Selecting Content Source
 * 
 * You can load content from all sources, or any individual source, from
 * URLs, the (default) filesystem, and the classpath. If you use the {@link #lookEverywhere()}
 * method go get your instance, then they are all included, in the order mentioned above.
 * However, it is possible to search within only one, or in a specific order by calling
 * the {@link #inURLs()}, the {@link #inFS()}, or the {@link #inClasspath()}, methods respectively.
 * For example, to search only in the local filesystem use {@link URIResolvers#inFS()} only.
 *
 * Reading Content
 * 
 * All of the
 * 
 */
public class URIResolvers {

    public static URIResolver lookEverywhere() {
        return new URIResolver().all();
    }

    public static URIResolver inFS() {
        return new URIResolver().inFS();
    }

    public static URIResolver inURLs() {
        return new URIResolver().inURLs();
    }

    public static URIResolver inClasspath() {
        return new URIResolver().inCP();
    }
}