diff options
Diffstat (limited to 'core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/IIndexInclude.java')
| -rw-r--r-- | core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/IIndexInclude.java | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/IIndexInclude.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/IIndexInclude.java new file mode 100644 index 00000000000..6b1381c5fca --- /dev/null +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/IIndexInclude.java @@ -0,0 +1,53 @@ +/******************************************************************************* + * Copyright (c) 2006 Wind River Systems, Inc. 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 + * + * Contributors: + * Markus Schorn - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.index; + +import org.eclipse.core.runtime.CoreException; + +/** + * Interface for an include directive stored in the index. + * <p> + * This interface is not intended to be implemented by clients. + * </p> + * <p> + * <strong>EXPERIMENTAL</strong>. This class or interface has been added as + * part of a work in progress. There is no guarantee that this API will work or + * that it will remain the same. Please do not use this API without consulting + * with the CDT team. + * </p> + * + * @since 4.0 + */ +public interface IIndexInclude { + IIndexInclude[] EMPTY_INCLUDES_ARRAY = new IIndexInclude[0]; + + /** + * Returns the file that contains this directive. + * @return the file performing the include + * @throws CoreException + */ + IIndexFile getIncludedBy() throws CoreException; + + /** + * Returns the absolute path of the location of the file that contains this directive. + * @return the absolute path of the location of the file performing the include + * @throws CoreException + */ + String getIncludedByLocation() throws CoreException; + + /** + * Returns the absolute path of the location of the file that is included by this directive. + * @return the absolute path of the location of the file that is included by this directive + * @throws CoreException + */ + String getIncludesLocation() throws CoreException; +} |