blob: 7d2db7d5465655a84b473e22f60ae91a4774ffee [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2012, 2013 Oracle. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0, which accompanies this distribution
* and is available at https://www.eclipse.org/legal/epl-2.0/.
*
* Contributors:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.common.utility.closure;
/**
* Simple interface for implementing a command that takes a single argument
* 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.
*
* @param <A> the type of the object passed to the command
*
* @see Closure
* @see org.eclipse.jpt.common.utility.command.InterruptibleCommand
* @see org.eclipse.jpt.common.utility.factory.InterruptibleFactory
* @see org.eclipse.jpt.common.utility.transformer.InterruptibleTransformer
*/
public interface InterruptibleClosure<A> {
/**
* Execute the command. The semantics of the command
* is determined by the contract between the client and server.
*/
void execute(A argument) throws InterruptedException;
}