blob: 213194fc09aff7fc663a11d47cde28a56641a9dd (
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
|
/*******************************************************************************
* Copyright (c) 2006 IBM Corporation 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.debug.ui.actions;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.model.IVariable;
/**
* An optional adapter used to create a watch expression for a selected variable.
* <p>
* The 'Create Watch Expression' action is enabled for instances of
* {@link org.eclipse.debug.core.model.IVariable} that have an associated
* {@link org.eclipse.debug.core.model.IWatchExpressionDelegate} registered
* for that debug model.
* When a watch expression factory adapter is available for a variable, the factory is
* consulted to create a watch expression for that variable. When no adapter is provided,
* the watch expression is generated based on the variable's name.
* </p>
* <p>
* Also see the optional interface {@link IWatchExpressionFactoryAdapterExtension}.
* </p>
* <p>
* Clients may implement this interface.
* </p>
* @since 3.2
*/
public interface IWatchExpressionFactoryAdapter {
/**
* Creates and returns an expression for the specified variable
* which is used to created an {@link org.eclipse.debug.core.model.IWatchExpression}.
*
* @param variable variable a watch expression is required for
* @return text used to create a watch expression
* @exception org.eclipse.core.runtime.CoreException if unable to create a watch
* expression
*/
public String createWatchExpression(IVariable variable) throws CoreException;
}
|