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

/*******************************************************************************
 * Copyright (c) 2000, 2007 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;

import org.eclipse.core.runtime.Assert;

/**
 * A TemplateVariableResolver resolves TemplateVariables
 * of a certain type inside a TemplateContext.
 * 
 * Clients may instantiate and extend this class.
 * 
 *
 * @see TemplateVariable
 * @since 3.0
 */
public class TemplateVariableResolver {

	/** Type of this resolver. */
	private String fType= null;

	/** Description of the type resolved by this resolver. */
	private String fDescription= null;

	/**
	 * Creates an instance of TemplateVariableResolver.
	 *
	 * @param type the name of the type
	 * @param description the description for the type
	 */
	protected TemplateVariableResolver(String type, String description) {
	 	setType(type);
	 	setDescription(description);
	}

	/**
	 * Creates an empty instance.
	 * 
	 * 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
	 * {@link #TemplateVariableResolver(String, String)} instead.
	 * 
	 */
	public TemplateVariableResolver() {
	}

	/**
	 * Returns the type of this resolver.
	 *
	 * @return the type
	 */
	public String getType() {
		return fType;
	}

	/**
	 * Returns the description for the resolver.
	 *
	 * @return the description for the resolver
	 */
	public String getDescription() {
		return fDescription;
	}

	/**
	 * Returns an instance of the type resolved by the receiver available in 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.
	 *
	 * @param context the context in which to resolve the type
	 * @return the name of the text object of this type, or null if it cannot be determined
	 */
	protected String resolve(TemplateContext context) {
		return context.getVariable(getType());
	}

	/**
	 * Returns all possible bindings available in context. The default
	 * implementation simply returns an array which contains the result of
	 * {@link #resolve(TemplateContext)}, or an empty array if that call returns
	 * null.
	 *
	 * @param context the context in which to resolve the type
	 * @return an array of possible bindings of this type in context
	 */
	protected String[] resolveAll(TemplateContext context) {
		String binding= resolve(context);
		if (binding == null)
			return new String[0];
		return new String[] { binding };
	}

	/**
	 * Resolves 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
	 * {@link TemplateVariable#setValues(String[])}.
	 *
	 * @param context the context in which variable is resolved
	 * @param variable the variable to resolve
	 */
	public void resolve(TemplateVariable variable, TemplateContext context) {
		String[] bindings= resolveAll(context);
		if (bindings.length != 0)
			variable.setValues(bindings);
		if (bindings.length > 1)
			variable.setUnambiguous(false);
		else
			variable.setUnambiguous(isUnambiguous(context));
		variable.setResolved(true);
	}

	/**
	 * Returns whether this resolver is able to resolve unambiguously. When
	 * resolving a 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.
	 *
	 * @param context the context in which the resolved check should be
	 *        evaluated
	 * @return true if the receiver is unambiguously resolvable
	 *         in context, false otherwise
	 */
	protected boolean isUnambiguous(TemplateContext context) {
		return false;
	}

	/**
	 * Sets the 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 {@link #TemplateVariableResolver(String, String)} instead.
	 * 
	 *
	 * @param description the description of this resolver
	 */
	public final void setDescription(String description) {
		Assert.isNotNull(description);
		Assert.isTrue(fDescription == null); // may only be called once when initialized
		fDescription= description;
	}

	/**
	 * Sets the type name.
	 * 
	 * 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 {@link #TemplateVariableResolver(String, String)} instead.
	 * 
	 *
	 * @param type the type name of this resolver
	 */
	public final void setType(String type) {
		Assert.isNotNull(type);
		Assert.isTrue(fType == null); // may only be called once when initialized
		fType= type;
	}
}