org.eclipse.text.templates.ContextTypeRegistry Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of aspectjtools Show documentation

AspectJ tools most notably contains the AspectJ compiler (AJC). AJC applies aspects to Java classes during compilation, fully replacing Javac for plain Java classes and also compiling native AspectJ or annotation-based @AspectJ syntax. Furthermore, AJC can weave aspects into existing class files in a post-compile binary weaving step. This library is a superset of AspectJ weaver and hence also of AspectJ runtime.

There is a newer version: 1.9.22.1

Show newest version

/*******************************************************************************
 * Copyright (c) 2000, 2018 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.text.templates;

import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map;

import org.eclipse.jface.text.templates.TemplateContextType;

/**
 * A registry for context types. Editor implementors will usually instantiate a
 * registry and configure the context types available in their editor.
 * 
 * In order to pick up templates contributed using the org.eclipse.ui.editors.templates
 * extension point, use a ContributionContextTypeRegistry.
 * 
 *
 * @since 3.7
 */
public class ContextTypeRegistry {

	/** all known context types */
	private final Map fContextTypes= new LinkedHashMap<>();

	/**
	 * Adds a context type to the registry. If there already is a context type
	 * with the same ID registered, it is replaced.
	 *
	 * @param contextType the context type to add
	 */
	public void addContextType(TemplateContextType contextType) {
		fContextTypes.put(contextType.getId(), contextType);
	}

	/**
	 * Returns the context type if the id is valid, null otherwise.
	 *
	 * @param id the id of the context type to retrieve
	 * @return the context type if name is valid, null otherwise
	 */
	public TemplateContextType getContextType(String id) {
		return fContextTypes.get(id);
	}

	/**
	 * Returns an iterator over all registered context types.
	 *
	 * @return an iterator over all registered context types
	 */
	public Iterator contextTypes() {
		return fContextTypes.values().iterator();
	}
}