Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 3885ec043419c26152c056a72c17eab3c31b9a78 (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
/*******************************************************************************
 * Copyright (c) 2000, 2005 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.core.variables;

import org.eclipse.core.runtime.CoreException;

/**
 * Resolves the value for a dynamic variable. A dynamic variable extension
 * contributes a resolver which must implement this interface.
 * <p>
 * Clients contributing a dynamic variable are intended to provide an implementation
 * of this interface.
 * </p>
 * @since 3.0
 */
public interface IDynamicVariableResolver {

	/**
	 * Resolves and returns a value for the specified variable when referenced
	 * with the given argument, possibly <code>null</code>
	 *
	 * @param variable variable to resolve a value for
	 * @param argument argument present in expression or <code>null</code> if none
	 * @return variable value, possibly <code>null</code>
	 * @throws CoreException if unable to resolve a value for the given variable
	 */
	String resolveValue(IDynamicVariable variable, String argument) throws CoreException;
}

Back to the top