Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 43ee484a9a36ddb77ab1e6ca223ccca9aacb01a7 (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
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
/*******************************************************************************
 * Copyright (c) 2011, 2012 Wind River Systems, Inc. and others. 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:
 * Wind River Systems - initial API and implementation
 *******************************************************************************/
package org.eclipse.tcf.te.runtime.stepper.stepper;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer;
import org.eclipse.tcf.te.runtime.stepper.StepperAttributeUtil;
import org.eclipse.tcf.te.runtime.stepper.interfaces.IStepContext;
import org.eclipse.tcf.te.runtime.stepper.interfaces.IContextManipulator;
import org.eclipse.tcf.te.runtime.stepper.interfaces.IStepper;
import org.eclipse.tcf.te.runtime.stepper.interfaces.IFullQualifiedId;

/**
 * A stepper implementation capable of handling multiple contexts.
 * <p>
 * The multi context stepper will sequential loop all configured contexts and invoke a single
 * context stepper for each context.
 */
public class MultiContextStepper extends SingleContextStepper {

	private List<IStepper> steppers = new ArrayList<IStepper>();

	public static final String CONTEXT_COUNT = "contextCount"; //$NON-NLS-1$
	public static final String CONTEXT_INDEX = "contextIndex"; //$NON-NLS-1$

	/**
	 * Constructor.
	 */
	public MultiContextStepper() {
		super();
	}

	/* (non-Javadoc)
	 * @see org.eclipse.tcf.te.runtime.stepper.extensions.AbstractStepper#onInitialize(org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer, org.eclipse.tcf.te.runtime.stepper.interfaces.IFullQualifiedId, org.eclipse.core.runtime.IProgressMonitor)
	 */
	@Override
	protected void onInitialize(IPropertiesContainer data, IFullQualifiedId fullQualifiedId, IProgressMonitor monitor) {
	    super.onInitialize(data, fullQualifiedId, monitor);

	    IStepContext[] contexts = getContexts();
	    for (IStepContext context : contexts) {
	    	if (context == null) continue;

	    	// Get the stepper to be used for this context object
	    	IStepper stepper = getStepper(context);
	    	Assert.isNotNull(stepper);

	    	// Build up a new fully qualified id
			IFullQualifiedId id = fullQualifiedId.createChildId(ID_TYPE_STEPPER_ID,
									(stepper.getId() != null ? stepper.getId() : "org.eclipse.tcf.te.runtime.stepper.singleContext"), //$NON-NLS-1$
									"" + steppers.size()); //$NON-NLS-1$

			// Initialize the stepper
			stepper.initialize(data, id, monitor);

			// Associate the context and context id with the calculated id
			StepperAttributeUtil.setProperty(IContextManipulator.CONTEXT, id, data, context);
			StepperAttributeUtil.setProperty(IContextManipulator.CONTEXT_ID, id, data, context.getId());

			// Add the stepper to the list
			steppers.add(stepper);
	    }
		data.setProperty("MULTI_CONTEXT", Boolean.toString(steppers.size() > 1)); //$NON-NLS-1$
	}

	/**
	 * Returns the stepper to be used for the given target context.
	 * <p>
	 * <b>Note:</b> The default implementation does always return a new single context stepper
	 * instance.
	 *
	 * @param context The context. Must not be <code>null</code>.
	 * @return The stepper instance.
	 */
	protected IStepper getStepper(IStepContext context) {
		Assert.isNotNull(context);
		return new SingleContextStepper();
	}

	/* (non-Javadoc)
	 * @see org.eclipse.tcf.te.runtime.stepper.extensions.AbstractStepper#internalExecute(java.util.List)
	 */
	@Override
	protected void internalExecute(List<IStatus> statusContainer) throws CoreException {
		int i = 0;
		StepperAttributeUtil.setProperty(CONTEXT_COUNT, null, getData(), steppers.size());
		for (IStepper stepper : steppers) {
			StepperAttributeUtil.setProperty(CONTEXT_INDEX, null, getData(), i++);
			try {
				stepper.execute();
			}
			catch (CoreException e) {
				if (isCancelable() && getMonitor() != null && getMonitor().isCanceled()) {
					throw e;
				}
				statusContainer.add(e.getStatus());
			}
		}
	}

	/* (non-Javadoc)
	 * @see org.eclipse.tcf.te.runtime.stepper.extensions.AbstractStepper#cleanup()
	 */
	@Override
	public void cleanup() {
		super.cleanup();

		for (IStepper stepper : steppers) {
			stepper.cleanup();
		}
		steppers.clear();
	}
}

Back to the top