blob: c7bfaa78f41e092b73e694f3176283602c52ba41 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
/*******************************************************************************
* 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.utility.command;
import java.io.Serializable;
import org.eclipse.jpt.common.utility.internal.StringTools;
/**
* Simple interface for implementing the GOF Command design pattern
* 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.utility.command.Command
*/
public interface InterruptibleCommand {
/**
* Execute the command. The semantics of the command
* is determined by the contract between the client and server.
*/
void execute() throws InterruptedException;
/**
* Singleton implementation of the interruptible command interface that
* will throw an interrupted exception when executed.
*/
final class Interrupted
implements InterruptibleCommand, Serializable
{
public static final InterruptibleCommand INSTANCE = new Interrupted();
public static InterruptibleCommand instance() {
return INSTANCE;
}
// ensure single instance
private Interrupted() {
super();
}
// throw an exception
public void execute() 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;
}
}
}
|
