org.stjs.generator.GenerationDirectory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of generator Show documentation
There is a newer version: 3.3.2.2
/**
 * Copyright 2011 Alexandru Craciun, Eyal Kaspi
 * 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 org.stjs.generator;

import java.io.File;
import java.net.URI;

/**
 * This class is used to provide the different parts of the target directory:
 * 
 * 
 *     the absolute path to the directory in which the generated .js source files are placed (during generation)
 * 
 * 
 *     the part relative to the project's directory used when the classpath for tests is built
 * 
 * 
 *     the path in the classpath of the final artifact in which the generated .js source files are placed. That path can then be used
 *     to load the generated .js files using Class.getResource() or ClassLoader.getResource(). That path is saved within the .stjs files
 *     and will be used later on, for example when this project is used as a dependency - jar/war
 * 
 * 
 * The 3 parts are different for the files generated for the main classes compared to the test classes
 * @author acraciun
 */
public class GenerationDirectory {
	private final File generatedSourcesAbsolutePath;
	private final URI generatedSourcesRuntimePath;
	private final File classpath;

	public GenerationDirectory(File generatedSourcesAbsolutePath, File classpath, URI generatedSourcesRuntimePath) {
		this.generatedSourcesAbsolutePath = generatedSourcesAbsolutePath;
		this.generatedSourcesRuntimePath = generatedSourcesRuntimePath;
		this.classpath = classpath;
	}

	public File getGeneratedSourcesAbsolutePath() {
		return generatedSourcesAbsolutePath;
	}

	public URI getGeneratedSourcesRuntimePath() {
		return generatedSourcesRuntimePath;
	}

	public File getClasspath() {
		return classpath;
	}

	@Override
	public String toString() {
		return "GenerationDirectory [generatedSourcesAbsolutePath=" + generatedSourcesAbsolutePath + ", classpath=" + classpath
				+ ", generatedSourcesRuntimePath=" + generatedSourcesRuntimePath
				+ "]";
	}
}