org.eclipse.core.resources.IMarkerDelta 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, 2010 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 java.util.Map;

/**
 * A marker delta describes the change to a single marker.
 * A marker can either be added, removed or changed.
 * Marker deltas give access to the state of the marker as it
 * was (in the case of deletions and changes) before the modifying
 * operation occurred.
 *
 * @noimplement This interface is not intended to be implemented by clients.
 * @noextend This interface is not intended to be extended by clients.
 */
public interface IMarkerDelta {
	/**
	 * Returns the object attribute with the given name.  The result is an instance of one
	 * of the following classes: String, Integer,
	 * or Boolean.
	 * Returns null if the attribute is undefined.
	 * The set of valid attribute names is defined elsewhere.
	 * 
	 * If kind is IResourceDelta.ADDED, then the information is
	 * from the new marker, otherwise it is from the old marker.
	 * 
	 * @param attributeName the name of the attribute
	 * @return the value, or null if the attribute is undefined.
	 */
	Object getAttribute(String attributeName);

	/**
	 * Returns the integer-valued attribute with the given name.
	 * Returns the given default value if the attribute is undefined
	 * or is not an integer value.
	 * 
	 * If kind is IResourceDelta.ADDED, then the information is
	 * from the new marker, otherwise it is from the old marker.
	 * 
	 *
	 * @param attributeName the name of the attribute
	 * @param defaultValue the value to use if the attribute does not exist
	 * @return the value or the default value if the attribute is undefined.
	 */
	int getAttribute(String attributeName, int defaultValue);

	/**
	 * Returns the string-valued attribute with the given name.
	 * Returns the given default value if the attribute is undefined or
	 * is not a string value.
	 * 
	 * If kind is IResourceDelta.ADDED, then the information is
	 * from the new marker, otherwise it is from the old marker.
	 * 
	 *
	 * @param attributeName the name of the attribute
	 * @param defaultValue the value to use if the attribute does not exist
	 * @return the value or the default value if the attribute is undefined.
	 */
	String getAttribute(String attributeName, String defaultValue);

	/**
	 * Returns the boolean-valued attribute with the given name.
	 * Returns the given default value if the attribute is undefined
	 * or is not a boolean value.
	 * 
	 * If kind is IResourceDelta.ADDED, then the information is
	 * from the new marker, otherwise it is from the old marker.
	 * 
	 *
	 * @param attributeName the name of the attribute
	 * @param defaultValue the value to use if the attribute does not exist
	 * @return the value or the default value if the attribute is undefined.
	 */
	boolean getAttribute(String attributeName, boolean defaultValue);

	/**
	 * Returns a Map with all the attributes for the marker.  The result is a Map
	 * whose keys are attributes names and whose values are attribute values.
	 * Each value an instance of one of the following classes: String,
	 * Integer, or Boolean. If the marker has no
	 * attributes then null is returned.
	 * 
	 * If kind is IResourceDelta.ADDED, then the information is
	 * from the new marker, otherwise it is from the old marker.
	 * 
	 *
	 * @return a map of attribute keys and values (key type : String
	 *		value type : String, Integer, or
	 *		Boolean) or null.
	 */
	Map getAttributes();

	/**
	 * Returns the attributes with the given names.  The result is an array
	 * whose elements correspond to the elements of the given attribute name
	 * array.  Each element is null or an instance of one
	 * of the following classes: String, Integer,
	 * or Boolean.
	 * 
	 * If kind is IResourceDelta.ADDED, then the information is
	 * from the new marker, otherwise it is from the old marker.
	 * 
	 *
	 * @param attributeNames the names of the attributes
	 * @return the values of the given attributes.
	 */
	Object[] getAttributes(String[] attributeNames);

	/**
	 * Returns the id of the marker.  The id of a marker is unique
	 * relative to the resource with which the marker is associated.
	 * Marker ids are not globally unique.
	 *
	 * @return the id of the marker
	 */
	long getId();

	/**
	 * Returns the kind of this marker delta:
	 * one of IResourceDelta.ADDED,
	 * IResourceDelta.REMOVED, or IResourceDelta.CHANGED.
	 *
	 * @return the kind of marker delta
	 * @see IResourceDelta#ADDED
	 * @see IResourceDelta#REMOVED
	 * @see IResourceDelta#CHANGED
	 */
	int getKind();

	/**
	 * Returns the marker described by this change.
	 * If kind is IResourceDelta.REMOVED, then this is the old marker,
	 * otherwise this is the new marker.  Note that if the marker was deleted,
	 * the value returned cannot be used to access attributes.
	 *
	 * @return the marker
	 */
	IMarker getMarker();

	/**
	 * Returns the resource with which this marker is associated.
	 *
	 * @return the resource
	 */
	IResource getResource();

	/**
	 * Returns the type of this marker.
	 * 
	 * If kind is IResourceDelta.ADDED, then the information is
	 * from the new marker, otherwise it is from the old marker.
	 * 
	 *
	 * @return the type of this marker
	 */
	String getType();

	/**
	 * Returns whether the type of this marker is considered to be a sub-type of
	 * the given marker type.
	 * 
	 * If kind is IResourceDelta.ADDED, then the information is
	 * from the new marker, otherwise it is from the old marker.
	 * 
	 *
	 * @return boolean trueif the marker's type
	 *		is the same as (or a sub-type of) the given type.
	 */
	boolean isSubtypeOf(String superType);
}