com.github.nosan.embedded.cassandra.cql.CqlScript Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.github.nosan.embedded.cassandra.cql;

import java.io.File;
import java.net.URL;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.Collection;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * CQL Script that abstracts from the actual type of underlying source.
 *
 * @author Dmytro Nosan
 * @see AbstractCqlScript
 * @see AbstractCqlResourceScript
 * @see CqlScripts
 * @see UrlCqlScript
 * @see ClassPathCqlScript
 * @see StaticCqlScript
 * @see FileCqlScript
 * @see PathCqlScript
 * @see InputStreamCqlScript
 * @since 1.0.0
 */
@FunctionalInterface
public interface CqlScript {
	/**
	 * Return CQL Statements.
	 *
	 * @return CQL statements.
	 */
	@Nonnull
	Collection getStatements();

	/**
	 * Factory method to create {@link CqlScripts} based on classpath locations.
	 *
	 * @param locations classpath locations
	 * @return CQL script
	 */
	@Nonnull
	static CqlScript classpath(@Nullable String... locations) {
		return classpath(null, locations);
	}

	/**
	 * Factory method to create {@link CqlScripts} based on classpath locations.
	 *
	 * @param locations classpath locations
	 * @param contextClass the class to load the resource with.
	 * @return CQL script
	 */
	@Nonnull
	static CqlScript classpath(@Nullable Class contextClass, @Nullable String... locations) {
		if (locations == null || locations.length == 0) {
			return new CqlScripts();
		}
		return new CqlScripts(Arrays.stream(locations)
				.map(l -> new ClassPathCqlScript(l, contextClass))
				.toArray(CqlScript[]::new));
	}

	/**
	 * Factory method to create {@link CqlScripts} based on urls.
	 *
	 * @param locations URL locations
	 * @return CQL script
	 */
	@Nonnull
	static CqlScript urls(@Nullable URL... locations) {
		if (locations == null || locations.length == 0) {
			return new CqlScripts();
		}
		return new CqlScripts(Arrays.stream(locations)
				.map(UrlCqlScript::new)
				.toArray(CqlScript[]::new));
	}

	/**
	 * Factory method to create {@link CqlScripts} based on files.
	 *
	 * @param locations File locations
	 * @return CQL script
	 */
	@Nonnull
	static CqlScript files(@Nullable File... locations) {
		if (locations == null || locations.length == 0) {
			return new CqlScripts();
		}
		return new CqlScripts(Arrays.stream(locations)
				.map(FileCqlScript::new)
				.toArray(CqlScript[]::new));
	}

	/**
	 * Factory method to create {@link CqlScripts} based on paths.
	 *
	 * @param locations Path locations
	 * @return CQL script
	 */
	@Nonnull
	static CqlScript paths(@Nullable Path... locations) {
		if (locations == null || locations.length == 0) {
			return new CqlScripts();
		}
		return new CqlScripts(Arrays.stream(locations)
				.map(PathCqlScript::new)
				.toArray(CqlScript[]::new));
	}

	/**
	 * Factory method to create {@link StaticCqlScript} based on statements.
	 *
	 * @param statements CQL statements
	 * @return CQL script
	 */
	@Nonnull
	static CqlScript statements(@Nullable String... statements) {
		return new StaticCqlScript(statements);
	}

}