Flapi.java

/*********************************************************************
 Copyright 2014 the Flapi 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 unquietcode.tools.flapi;

import unquietcode.tools.flapi.annotations.AnnotationIntrospector;
import unquietcode.tools.flapi.builder.Descriptor.DescriptorBuilder;
import unquietcode.tools.flapi.builder.Descriptor.DescriptorGenerator;
import unquietcode.tools.flapi.configurator.DescriptorConfigurator.DescriptorConfiguratorBuilder;
import unquietcode.tools.flapi.configurator.DescriptorConfigurator.DescriptorConfiguratorGenerator;
import unquietcode.tools.flapi.helpers.DescriptorConfiguratorHelperImpl;
import unquietcode.tools.flapi.helpers.DescriptorHelperImpl;
import unquietcode.tools.flapi.outline.DescriptorOutline;
import unquietcode.tools.flapi.runtime.ExecutionListener;

import javax.lang.model.SourceVersion;

import static com.google.common.base.Preconditions.checkNotNull;

/**
 * From here you can reach the world.
 *
 * @author Ben Fagin
 * @version 05-11-2012
 */
public class Flapi {
	private static SourceVersion JDKVersion = SourceVersion.RELEASE_8;
	private static boolean outputRuntime = false;


	/**
	 * Shortcut to build a new descriptor.
	 *
	 * @param listeners any execution listeners to be included
	 * @return a new descriptor builder
	 */
	public static DescriptorBuilder.Start builder(ExecutionListener...listeners) {
		return DescriptorGenerator.create(new DescriptorHelperImpl(), listeners);
	}

	/**
	 * Shortcut to build a descriptor from an existing annotated helper class.
	 *
	 * @param topBlock the top-level annotated class
	 * @return a new descriptor builder
	 *
	 * @see unquietcode.tools.flapi.annotations.AnnotationIntrospector
	 */
	public static DescriptorConfiguratorBuilder.Start create(Class<?> topBlock) {
		checkNotNull(topBlock, "a starting block is required");

		DescriptorOutline outline = AnnotationIntrospector.createDescriptor(topBlock);
		DescriptorConfiguratorHelperImpl helper = new DescriptorConfiguratorHelperImpl(outline);

		return DescriptorConfiguratorGenerator.create(helper);
	}

	/**
	 * Set the JDK version that Flapi should use when generating source files.
	 * Certain features are only available in newer versions of the runtime.
	 *
	 * @param version the JDK version to use when generating sources
	 */
	public static void setJDKVersion(SourceVersion version) {
		if (version != null && version.ordinal() >= SourceVersion.RELEASE_5.ordinal()) {
			JDKVersion = version;
		} else {
			throw new DescriptorBuilderException("Only JDK versions [5,8] are supported.");
		}
	}

	/**
	 * @return the JDK version currently being used when generating source files.
	 */
	public static SourceVersion getJDKVersion() {
		return JDKVersion;
	}

	public static boolean shouldOutputRuntime() {
		return outputRuntime;
	}

	public static void shouldOutputRuntime(boolean outputRuntime) {
		Flapi.outputRuntime = outputRuntime;
	}

	/*package*/ static boolean not(boolean condition) {
		return !condition;
	}
}