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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.xtend.standalone Show documentation

There is a newer version: 2.4.3

Show newest version

/*******************************************************************************
 * Copyright (c) 2011 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.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.xtext.resource.impl.DefaultResourceDescriptionStrategy;
import org.eclipse.xtext.util.IAcceptor;

import com.google.inject.ImplementedBy;

/**
 * Allows easy way to customize of what is indexed, i.e. put into a
 * {@link org.eclipse.xtext.resource.impl.DefaultReferenceDescription}.
 * 
 * @author Jan Koehnlein - Initial contribution and API
 */
@ImplementedBy(DefaultResourceDescriptionStrategy.class)
public interface IDefaultResourceDescriptionStrategy {

	/**
	 * Calculates the {@link IEObjectDescription}s for eObject and passes them to the acceptor.
	 * 
	 * @return true if the children of eObject should be traversed.
	 */
	boolean createEObjectDescriptions(EObject eObject, IAcceptor acceptor);

	/**
	 * Calculates the {@link IReferenceDescription}s for external cross references from eObject and passes
	 * them to the acceptor.
	 * 
	 * @return true if the children of eObject should be traversed.
	 */
	boolean createReferenceDescriptions(EObject eObject, URI exportedContainerURI, IAcceptor acceptor);
}