org.parallelj.Programs Maven / Gradle / Ivy

Go to download

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

ParallelJ is a Java framework for parallel computing. It provides flow modeling and execution. This project contains the core of ParallelJ which brings the execution engine, but also all the elements you need to define a ParallelJ program: annotations, libraries, etc.

There is a newer version: 1.4.1

Show 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;

import java.util.concurrent.ExecutorService;

import org.parallelj.internal.reflect.ProgramAdapter;
import org.parallelj.mirror.Process;
import org.parallelj.mirror.ProcessState;

/**
 * Helper class for classes annotated with {@link Program}.
 * 
 * @author Atos Worldline
 * 
 */
public class Programs {
	
	/**
	 * Hepler interface to {@link Process} and {@link org.parallelj.mirror.Processor}
	 *  
	 * @author Laurent Legrand
	 *
	 * @param 
	 */
	public interface ProcessHelper {
		
		/**
		 * Return the context bound to the process.
		 * 
		 * @return the context bound to the process.
		 */
		public E context();

		/**
		 * Execute the process with the current thread.
		 * 
		 * @return itself for method chaining.
		 */
		public ProcessHelper execute();

		/**
		 * Execute the process with a specific executor service.
		 * 
		 * @param service
		 *            the {@link ExecutorService} that will be used to execute
		 *            procedure call.
		 * @return itself for method chaining.
		 */
		public ProcessHelper execute(ExecutorService service);

		/**
		 * Abort the process.
		 * 
		 * @return itself for method chaining.
		 */
		public ProcessHelper abort();

		/**
		 * Terminate the process.
		 * 
		 * @return itself for method chaining.
		 */
		public ProcessHelper terminate();

		/**
		 * Suspend the execution of the process.
		 * 
		 * @return itself for method chaining.
		 */
		public ProcessHelper suspend();

		/**
		 * Resume the execution of the process.
		 * 
		 * @return itself for method chaining.
		 */
		public ProcessHelper resume();

		/**
		 * Wait for the completion of the process.
		 * 
		 * @return itself for method chaining.
		 */
		public ProcessHelper join();
		
		/**
		 * Return the underlying {@link Process}
		 * 
		 * @return the underlying {@link Process}
		 */
		public Process getProcess();
		
		/**
		 * Return the state of the {@link Process}
		 * 
		 * @return the state of the {@link Process}
		 */
		public ProcessState getState();
		
	}

	/**
	 * Adapt an object to a {@link Process}.
	 * 
	 * @param 
	 * @param e
	 *            the object to adapt
	 * @return the corresponding process
	 * @throws IllegalArgumentException
	 *             if the class of the parameter is not annotated by
	 *             {@link Program}
	 */
	public static  ProcessHelper as(E e)
			throws IllegalArgumentException {
		return ProgramAdapter.as(e);
	}

}