org.parallelj.launching.Launcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of parallelj-launching Show documentation

ParallelJ is a Java framework for parallel computing. It provides flow modeling and execution. This projet covers the launching of a ParallelJ program purpose. It allows to launch easily the programs, and access them remotely.

The newest version!

/*
 *     ParallelJ, framework for parallel computing
 *
 *     Copyright (C) 2010, 2011, 2012 Atos Worldline or third-party contributors as
 *     indicated by the @author tags or express copyright attribution
 *     statements applied by the authors.
 *
 *     This library is free software; you can redistribute it and/or
 *     modify it under the terms of the GNU Lesser General Public
 *     License as published by the Free Software Foundation; either
 *     version 2.1 of the License.
 *
 *     This library is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 *     Lesser General Public License for more details.
 *
 *     You should have received a copy of the GNU Lesser General Public
 *     License along with this library; if not, write to the Free Software
 *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
package org.parallelj.launching;

import java.util.concurrent.ExecutorService;

import org.parallelj.launching.internal.LaunchImpl;

/**
 * Entry point for launching {@link org.parallelj.Program Programs}.
 */
public final class Launcher {

	/**
	 * Static internal class, in charge of holding the Singleton instance.
	 */
	private static class SingletonHolder {
		static Launcher instance = new Launcher();
	}

	/**
	 * Private Constructor for the unique Launcher instance.
	 */
	private Launcher() {
	}

	/**
	 * Get the unique instance of Launcher.
	 * 
	 * @return The Launcher unique instance.
	 * 
	 * @throws LaunchException
	 *             If an Exception occurred when creating instance.
	 */
	public static Launcher getLauncher() throws LaunchException {
		return SingletonHolder.instance;
	}

	/**
	 * Create a new instance of {@link Launch} for a
	 * {@link org.parallelj.Program Program} execution.
	 * 
	 * @param programClass
	 *            The class of the {@link org.parallelj.Program Program}.
	 * 
	 * @return a {@link Launch} instance.
	 * 
	 * @throws LaunchException
	 */
	public  Launch newLaunch(Class programClass)
			throws LaunchException {
		return newLaunch(programClass, null);
	}

	/**
	 * Create a new instance of {@link Launch} for a
	 * {@link org.parallelj.Program Program} execution using an
	 * {@link ExecutorService}.
	 * 
	 * @param programClass
	 *            The Program Adapter class.
	 * 
	 * @param executorService
	 *            The ExecutorService instance to use.
	 * 
	 * @return An instance of Launch.
	 * 
	 * @throws LaunchException
	 */
	public synchronized  Launch newLaunch(
			final Class programClass,
			ExecutorService executorService) throws LaunchException {
		return new LaunchImpl(programClass, executorService);
	}

}