added missing action descriptions
[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
16  * a singleton. That is, only one instance will be created
17  * per variable extension.
18  * </p><p>
19  * This interface is not to be extended by clients. Clients
20  * may implement this interface.
21  * </p>
22  */
23 public interface IVariableTextExpander {
24         /**
25          * Returns the expanded text for the given variable
26          * tag and value.
27          * 
28          * @param varTag the variable tag name
29          * @param varValue the value for the variable
30          * @param context the context the variable should use to expand itself
31          * @return the text of the expanded variable
32          *              or <code>null</code> if not possible
33          */
34         public String getText(String varTag, String varValue, ExpandVariableContext context);
35 }