blob: a034d865fe334acf9900e6e311cd071b5f1b7406 (
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
|
/*******************************************************************************
* 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.interfaces;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer;
/**
* Interface to be implemented by objects representing a context for a step.
*/
public interface IStepContext extends IAdaptable {
/**
* Returns the context id.
*
* @return The context id or <code>null</code>.
*/
public String getId();
/**
* Returns the context secondary id.
*
* @return The context secondary id or <code>null</code>.
*/
public String getSecondaryId();
/**
* Returns a name/label to be used within the UI to represent this context
* to the user.
*
* @return The name or <code>null</code>.
*/
public String getName();
/**
* Returns the context object.
*
* @return The context Object. Must not be <code>null</code>.
*/
public Object getContextObject();
/**
* Returns a possible multi-line string providing detail information
* about the context which shall be included in failure messages.
*
* @param data The step data. Must not be <code>null</code>.
* @return The context information or <code>null</code>.
*/
public String getInfo(IPropertiesContainer data);
}
|
