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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/*******************************************************************************
* 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;
}
}
}
|
