common/plugins/org.eclipse.jpt.common.core/src/org/eclipse/jpt/common/core/utility/command/JobCommandExecutor.java

/*******************************************************************************
 * Copyright (c) 2012 Oracle. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0, which accompanies this distribution
 * and is available at http://www.eclipse.org/legal/epl-v10.html.
 * 
 * Contributors:
 *     Oracle - initial API and implementation
 ******************************************************************************/
package org.eclipse.jpt.common.core.utility.command;

import java.io.Serializable;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.jobs.ISchedulingRule;
import org.eclipse.jpt.common.utility.internal.StringTools;

/**
 * This interface allows clients to control how a job command is executed.
 * This is useful when the server provides the command but the client provides
 * the context (e.g. the client would like to execute the command synchronously
 * rather than dispatching it to a job queue).
 * <p>
 * Provisional API: This interface is part of an interim API that is still
 * under development and expected to change significantly before reaching
 * stability. It is available at this early stage to solicit feedback from
 * pioneering adopters on the understanding that any code that uses this API
 * will almost certainly be broken (repeatedly) as the API evolves.
 */
public interface JobCommandExecutor {

	/**
	 * Execute the specified command, synchronously or asynchronously.
	 * Commands with the same scheduling rule must be executed in the order in
	 * which they are passed to the command executor.
	 * The command may or may not be assigned to a
	 * {@link org.eclipse.core.runtime.jobs.Job} for execution.
	 */
	void execute(JobCommand command);

	/**
	 * Execute the specified command, synchronously or asynchronously.
	 * Commands with the same scheduling rule must be executed in the order in
	 * which they are passed to the command executor.
	 * The command may or may not be assigned to a
	 * {@link org.eclipse.core.runtime.jobs.Job} for execution.
	 */
	void execute(JobCommand command, String jobName);

	/**
	 * Execute the specified command, synchronously or asynchronously.
	 * Commands with the same scheduling rule must be executed in the order in
	 * which they are passed to the command executor.
	 * The command may or may not be assigned to a
	 * {@link org.eclipse.core.runtime.jobs.Job} for execution.
	 */
	void execute(JobCommand command, String jobName, ISchedulingRule schedulingRule);


	/**
	 * Singleton implementation of the command executor interface
	 * that simply executes the command without any sort of enhancement.
	 */
	final class Default
		implements JobCommandExecutor, Serializable
	{
		public static final JobCommandExecutor INSTANCE = new Default();
		public static JobCommandExecutor instance() {
			return INSTANCE;
		}
		// ensure single instance
		private Default() {
			super();
		}
		public void execute(JobCommand command) {
			command.execute(new NullProgressMonitor());
		}
		public void execute(JobCommand command, String jobName) {
			this.execute(command);
		}
		public void execute(JobCommand command, String jobName, ISchedulingRule schedulingRule) {
			this.execute(command);
		}
		@Override
		public String toString() {
			return StringTools.buildSingletonToString(this);
		}
		private static final long serialVersionUID = 1L;
		private Object readResolve() {
			// replace this object with the singleton
			return INSTANCE;
		}
	}


	/**
	 * Singleton implementation of the command executor interface
	 * that ignores any commands.
	 */
	final class Inactive
		implements JobCommandExecutor, Serializable
	{
		public static final JobCommandExecutor INSTANCE = new Inactive();
		public static JobCommandExecutor instance() {
			return INSTANCE;
		}
		// ensure single instance
		private Inactive() {
			super();
		}
		public void execute(JobCommand command) {
			// do nothing
		}
		public void execute(JobCommand command, String jobName) {
			// do nothing
		}
		public void execute(JobCommand command, String jobName, ISchedulingRule schedulingRule) {
			// do nothing
		}
		@Override
		public String toString() {
			return StringTools.buildSingletonToString(this);
		}
		private static final long serialVersionUID = 1L;
		private Object readResolve() {
			// replace this object with the singleton
			return INSTANCE;
		}
	}
}