org.eclipse.core.resources.IResourceProxy 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, 2009 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.core.resources;

import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.QualifiedName;

/**
 * A lightweight interface for requesting information about a resource.
 * All of the "get" methods on a resource proxy have trivial performance cost.
 * Requesting the full path or the actual resource handle will cause extra objects
 * to be created and will thus have greater cost.
 * 
 * When a resource proxy is used within an {@link IResourceProxyVisitor},
 * it is a transient object that is only valid for the duration of a single visit method.
 * A proxy should not be referenced once the single resource visit is complete.
 * The equals and hashCode methods should not be relied on.
 * 
 * 
 * A proxy can also be created using {@link IResource#createProxy()}. In
 * this case the proxy is valid indefinitely, but will not remain in sync with
 * the state of the corresponding resource.
 * 
 *
 * @see IResourceProxyVisitor
 * @since 2.1
 * @noimplement This interface is not intended to be implemented by clients.
 * @noextend This interface is not intended to be extended by clients.
 */
public interface IResourceProxy {
	/**
	 * Returns the modification stamp of the resource being visited.
	 *
	 * @return the modification stamp, or NULL_STAMP if the
	 * resource either does not exist or exists as a closed project
	 * @see IResource#getModificationStamp()
	 */
	long getModificationStamp();

	/**
	 * Returns whether the resource being visited is accessible.
	 *
	 * @return true if the resource is accessible, and
	 * false otherwise
	 * @see IResource#isAccessible()
	 */
	boolean isAccessible();

	/**
	 * Returns whether the resource being visited is derived.
	 *
	 * @return true if the resource is marked as derived, and
	 * false otherwise
	 * @see IResource#isDerived()
	 */
	boolean isDerived();

	/**
	 * Returns whether the resource being visited is a linked resource.
	 *
	 * @return true if the resource is linked, and
	 * false otherwise
	 * @see IResource#isLinked()
	 */
	boolean isLinked();

	/**
	 * Returns whether the resource being visited is a phantom resource.
	 *
	 * @return true if the resource is a phantom resource, and
	 * false otherwise
	 * @see IResource#isPhantom()
	 */
	boolean isPhantom();

	/**
	 * Returns whether the resource being visited is a hidden resource.
	 *
	 * @return true if the resource is a hidden resource, and
	 * false otherwise
	 * @see IResource#isHidden()
	 *
	 * @since 3.4
	 */
	boolean isHidden();

	/**
	 * Returns whether the resource being visited is a team private member.
	 *
	 * @return true if the resource is a team private member, and
	 * false otherwise
	 * @see IResource#isTeamPrivateMember()
	 */
	boolean isTeamPrivateMember();

	/**
	 * Returns the simple name of the resource being visited.
	 *
	 * @return the name of the resource
	 * @see IResource#getName()
	 */
	String getName();

	/**
	 * Returns the value of the session property of the resource being
	 * visited, identified by the given key.  Returns null if this
	 * resource has no such property.
	 * 
	 * Note that this method can return an out of date property value, or a
	 * value that no longer exists, if session properties are being modified
	 * concurrently with the resource visit.
	 * 
	 *
	 * @param key the qualified name of the property
	 * @return the string value of the session property,
	 *     or null if the resource has no such property
	 *	 @see IResource#getSessionProperty(QualifiedName)
	 */
	Object getSessionProperty(QualifiedName key);

	/**
	 * Returns the type of the resource being visited.
	 *
	 * @return the resource type
	 * @see IResource#getType()
	 */
	int getType();

	/**
	 * Returns the full workspace path of the resource being visited.
	 * 
	 * Note that this is not a "free" proxy operation.  This method
	 * will generally cause a path object to be created.  For an optimal
	 * visitor, only call this method when absolutely necessary.  Note that the
	 * simple resource name can be obtained from the proxy with no cost.
	 * 
	 * @return the full path of the resource
	 * @see IResource#getFullPath()
	 */
	IPath requestFullPath();

	/**
	 * Returns the handle of the resource being visited.
	 * 
	 * Note that this is not a "free" proxy operation.  This method will
	 * generally cause both a path object and a resource object to be created.
	 * For an optimal visitor, only call this method when absolutely necessary.
	 * Note that the simple resource name can be obtained from the proxy with no
	 * cost, and the full path of the resource can be obtained through the proxy
	 * with smaller cost.
	 * 
	 * @return the resource handle
	 */
	IResource requestResource();
}