diff options
Diffstat (limited to 'common/plugins/org.eclipse.jpt.common.core/src/org/eclipse/jpt/common/core/utility/command/InterruptibleJobCommand.java')
-rw-r--r-- | common/plugins/org.eclipse.jpt.common.core/src/org/eclipse/jpt/common/core/utility/command/InterruptibleJobCommand.java | 81 |
1 files changed, 0 insertions, 81 deletions
diff --git a/common/plugins/org.eclipse.jpt.common.core/src/org/eclipse/jpt/common/core/utility/command/InterruptibleJobCommand.java b/common/plugins/org.eclipse.jpt.common.core/src/org/eclipse/jpt/common/core/utility/command/InterruptibleJobCommand.java deleted file mode 100644 index 4eb68d4bbb..0000000000 --- a/common/plugins/org.eclipse.jpt.common.core/src/org/eclipse/jpt/common/core/utility/command/InterruptibleJobCommand.java +++ /dev/null @@ -1,81 +0,0 @@ -/******************************************************************************* - * 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.IProgressMonitor; -import org.eclipse.core.runtime.IStatus; -import org.eclipse.jpt.common.utility.internal.StringTools; - -/** - * Simple interface for implementing the GOF Command design pattern - * in an Eclipse job - * and allows for the command to throw an {@link InterruptedException}. - * <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. - * - * @see org.eclipse.jpt.common.core.utility.command.JobCommand - */ -public interface InterruptibleJobCommand { - - /** - * Execute the command. The semantics of the command - * is determined by the contract between the client and server. - * The command should check, as appropriate, whether the specified progress - * monitor is {@link IProgressMonitor#isCanceled() "canceled"}; if it is, - * the command should return a result - * status of severity {@link IStatus#CANCEL}. The singleton - * cancel status {@link org.eclipse.core.runtime.Status#CANCEL_STATUS} can be used for - * this purpose. - * <p> - * Nested methods can also check the progress monitor - * and, if it is "canceled", throw an - * {@link org.eclipse.core.runtime.OperationCanceledException OperationCanceledException}. - * - * @see IProgressMonitor#isCanceled() - * @see org.eclipse.core.runtime.jobs.Job#run(IProgressMonitor monitor) - */ - IStatus execute(IProgressMonitor monitor) throws InterruptedException; - - - /** - * Singleton implementation of the interruptible job command interface that - * will throw an interrupted exception when executed. - */ - final class Interrupted - implements InterruptibleJobCommand, Serializable - { - public static final InterruptibleJobCommand INSTANCE = new Interrupted(); - public static InterruptibleJobCommand instance() { - return INSTANCE; - } - // ensure single instance - private Interrupted() { - super(); - } - // throw an exception - public IStatus execute(IProgressMonitor monitor) throws InterruptedException { - throw new InterruptedException(); - } - @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; - } - } -} |