|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.text.templates.TemplateVariableResolver
public class TemplateVariableResolver
A TemplateVariableResolver resolves TemplateVariables
of a certain type inside a TemplateContext.
Clients may instantiate and extend this class.
TemplateVariable| Constructor Summary | |
|---|---|
|
TemplateVariableResolver()
Creates an empty instance. |
protected |
TemplateVariableResolver(java.lang.String type,
java.lang.String description)
Creates an instance of TemplateVariableResolver. |
| Method Summary | |
|---|---|
java.lang.String |
getDescription()
Returns the description for the resolver. |
java.lang.String |
getType()
Returns the type of this resolver. |
protected boolean |
isUnambiguous(TemplateContext context)
Returns whether this resolver is able to resolve unambiguously. |
protected java.lang.String |
resolve(TemplateContext context)
Returns an instance of the type resolved by the receiver available in context. |
void |
resolve(TemplateVariable variable,
TemplateContext context)
Resolves variable in context. |
protected java.lang.String[] |
resolveAll(TemplateContext context)
Returns all possible bindings available in context. |
void |
setDescription(java.lang.String description)
Sets the description. |
void |
setType(java.lang.String type)
Sets the type name. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected TemplateVariableResolver(java.lang.String type,
java.lang.String description)
TemplateVariableResolver.
type - the name of the typedescription - the description for the typepublic TemplateVariableResolver()
This is a framework-only constructor that exists only so that resolvers
can be contributed via an extension point and that should not be called
in client code except for subclass constructors; use
TemplateVariableResolver(String, String) instead.
| Method Detail |
|---|
public java.lang.String getType()
public java.lang.String getDescription()
protected java.lang.String resolve(TemplateContext context)
context.
To resolve means to provide a binding to a concrete text object (a
String) in the given context.
The default implementation looks up the type in the context.
context - the context in which to resolve the type
null if it cannot be determinedprotected java.lang.String[] resolveAll(TemplateContext context)
context. The default
implementation simply returns an array which contains the result of
resolve(TemplateContext), or an empty array if that call returns
null.
context - the context in which to resolve the type
context
public void resolve(TemplateVariable variable,
TemplateContext context)
variable in context. To resolve
means to find a valid binding of the receiver's type in the given TemplateContext.
If the variable can be successfully resolved, its value is set using
TemplateVariable.setValues(String[]).
context - the context in which variable is resolvedvariable - the variable to resolveprotected boolean isUnambiguous(TemplateContext context)
TemplateVariable, its isUmambiguous
state is set to the one of this resolver. By default, this method
returns false. Clients can overwrite this method to give
a hint about whether there should be e.g. prompting for input values for
ambiguous variables.
context - the context in which the resolved check should be
evaluated
true if the receiver is unambiguously resolvable
in context, false otherwisepublic final void setDescription(java.lang.String description)
This is a framework-only method that exists only so that resolvers
can be contributed via an extension point and that should not be called
in client code; use TemplateVariableResolver(String, String) instead.
description - the description of this resolverpublic final void setType(java.lang.String type)
This is a framework-only method that exists only so that resolvers
can be contributed via an extension point and that should not be called
in client code; use TemplateVariableResolver(String, String) instead.
type - the type name of this resolver
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.