All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.eclipse.xtext.resource.ILocationInFileProvider Maven / Gradle / Ivy

There is a newer version: 2.4.3
Show newest version
/*******************************************************************************
 * Copyright (c) 2008 itemis AG (http://www.itemis.eu) and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 *******************************************************************************/
package org.eclipse.xtext.resource;

import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.xtext.util.ITextRegion;

import com.google.inject.ImplementedBy;

/**
 * Delivers {@link ITextRegion}s for model elements or feature settings. The significant text is the part of the text
 * identifying the element, e.g. its name, as opposed to the full region which is the full text representing the
 * element.
 * In addition to this service, the extension interface {@link ILocationInFileProviderExtension} allows to query 
 * for the region that is spanned by an {@link EObject} including its comments.
 * 
 * @author Sven Efftinge - Initial contribution and API
 * @author Jan Koehnlein - Distinguish significant and full region
 */
@ImplementedBy(DefaultLocationInFileProvider.class)
public interface ILocationInFileProvider {

	ITextRegion getSignificantTextRegion(EObject obj);

	ITextRegion getSignificantTextRegion(EObject owner, EStructuralFeature feature, int indexInList);

	ITextRegion getFullTextRegion(EObject obj);

	ITextRegion getFullTextRegion(EObject owner, EStructuralFeature feature, int indexInList);
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy