org.eclipse.jface.text.templates

Class TemplateContext

java.lang.Object

org.eclipse.jface.text.templates.TemplateContext

All Implemented Interfaces:

IAdaptable

Direct Known Subclasses:

DocumentTemplateContext

public abstract class TemplateContext
extends Object
implements IAdaptable

Provides the context for a Template being resolved. Keeps track of resolved variables.

Clients may extend this class.

Since:

3.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TemplateContext(TemplateContextType contextType) Creates a template context of a particular context type.

Method Summary

Modifier and Type	Method and Description
abstract boolean	canEvaluate(Template template) Tests if the specified template can be evaluated in this context.
abstract TemplateBuffer	evaluate(Template template) Evaluates the template in this context and returns a template buffer.
<T> T	getAdapter(Class<T> adapter) Default implementation does nothing, clients can override to provide adapters.
TemplateContextType	getContextType() Returns the context type of this context.
String	getVariable(String name) Returns the value of a defined variable.
boolean	isReadOnly() Returns true if the receiver is read-only, false otherwise.
void	setReadOnly(boolean readOnly) Sets or clears the read-only flag.
void	setVariable(String name, String value) Defines the value of a variable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TemplateContext

protected TemplateContext(TemplateContextType contextType)

Creates a template context of a particular context type.

Parameters:

contextType - the context type of this context

Method Detail

getContextType

public TemplateContextType getContextType()

Returns the context type of this context.

Returns:

the context type of this context

setReadOnly

public void setReadOnly(boolean readOnly)

Sets or clears the read-only flag.

Parameters:

readOnly - the new read-only state

isReadOnly

public boolean isReadOnly()

Returns true if the receiver is read-only, false otherwise.

Returns:

true if the receiver is read-only, false otherwise

setVariable

public void setVariable(String name,
                        String value)

Defines the value of a variable.

Parameters:

name - the name of the variable

value - the value of the variable, null to un-define a variable

getVariable

public String getVariable(String name)

Returns the value of a defined variable.

Parameters:

name - the name of the variable

Returns:

returns the value of the variable, null if the variable was not defined

evaluate

public abstract TemplateBuffer evaluate(Template template)
                                 throws BadLocationException,
                                        TemplateException

Evaluates the template in this context and returns a template buffer.

Evaluation means translating the template into a TemplateBuffer, resolving the defined variables in this context and possibly formatting the resolved buffer.

Parameters:

template - the template to evaluate

Returns:

returns the buffer with the evaluated template or null if the buffer could not be created

Throws:

BadLocationException - if evaluation fails due to concurrently changed documents etc.

TemplateException - if the template specification is not valid

canEvaluate

public abstract boolean canEvaluate(Template template)

Tests if the specified template can be evaluated in this context.

Examples are templates defined for a different context (e.g. a javadoc template cannot be evaluated in Java context).

Parameters:

template - the Template to check

Returns:

true if template can be evaluated in this context, false otherwise

getAdapter

public <T> T getAdapter(Class<T> adapter)

Default implementation does nothing, clients can override to provide adapters. Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Clients may implement this method but should generally call Adapters.adapt(Object, Class, boolean) rather than invoking it directly.

Specified by:

getAdapter in interface IAdaptable

Parameters:

adapter - the adapter class to look up

Returns:

a object of the given class, or null if this object does not have an adapter for the given class