org.eclipse.jface.text.templates.SimpleTemplateVariableResolver Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2000, 2005 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.text.templates;


/**
 * A simple template variable resolver, which always evaluates to a defined string.
 * 
 * Clients may instantiate and extend this class.
 * 
 *
 * @since 3.0
 */
public class SimpleTemplateVariableResolver extends TemplateVariableResolver {

	/** The string to which this variable evaluates. */
	private String fEvaluationString;

	/*
	 * @see TemplateVariableResolver#TemplateVariableResolver(String, String)
	 */
	protected SimpleTemplateVariableResolver(String type, String description) {
		super(type, description);
	}

	/**
	 * Sets the string to which this variable evaluates.
	 *
	 * @param evaluationString the evaluation string, may be null.
	 */
	public final void setEvaluationString(String evaluationString) {
		fEvaluationString= evaluationString;
	}

	/*
	 * @see TemplateVariableResolver#evaluate(TemplateContext)
	 */
	@Override
	protected String resolve(TemplateContext context) {
		return fEvaluationString;
	}

	/**
	 * Returns always true, since simple variables are normally
	 * unambiguous.
	 *
	 * @param context {@inheritDoc}
	 * @return true
	 */
	@Override
	protected boolean isUnambiguous(TemplateContext context) {
		return true;
	}
}