ed_mann's fix for ticket #322
[phpeclipse.git] / net.sourceforge.phpeclipse.externaltools / src / net / sourceforge / phpdt / externaltools / variable / IVariableTextExpander.java
1 package net.sourceforge.phpdt.externaltools.variable;
2
3 /**********************************************************************
4  Copyright (c) 2002 IBM Corp. and others. All rights reserved.
5  This file is made available under the terms of the Common Public License v1.0
6  which accompanies this distribution, and is available at
7  http://www.eclipse.org/legal/cpl-v10.html
8  �
9  Contributors:
10  **********************************************************************/
11
12 /**
13  * Responsible for expanding a variable into text format.
14  * <p>
15  * Implementation of this interface will be treated like a singleton. That is,
16  * only one instance will be created per variable extension.
17  * </p>
18  * <p>
19  * This interface is not to be extended by clients. Clients may implement this
20  * interface.
21  * </p>
22  */
23 public interface IVariableTextExpander {
24         /**
25          * Returns the expanded text for the given variable tag and value.
26          * 
27          * @param varTag
28          *            the variable tag name
29          * @param varValue
30          *            the value for the variable
31          * @param context
32          *            the context the variable should use to expand itself
33          * @return the text of the expanded variable or <code>null</code> if not
34          *         possible
35          */
36         public String getText(String varTag, String varValue,
37                         ExpandVariableContext context);
38 }