org.aspectj.lang.JoinPoint Maven / Gradle / Ivy
Show all versions of aspectjtools Show documentation
/* *******************************************************************
* Copyright (c) 1999-2001 Xerox Corporation,
* 2002 Palo Alto Research Center, Incorporated (PARC).
* 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:
* Xerox/PARC initial implementation
* ******************************************************************/
package org.aspectj.lang;
import org.aspectj.lang.reflect.SourceLocation;
/**
* Provides reflective access to both the state available at a join point and
* static information about it. This information is available from the body
* of advice using the special form thisJoinPoint. The primary
* use of this reflective information is for tracing and logging applications.
*
*
*
* aspect Logging {
* before(): within(com.bigboxco..*) && execution(public * *(..)) {
* System.err.println("entering: " + thisJoinPoint);
* System.err.println(" w/args: " + thisJoinPoint.getArgs());
* System.err.println(" at: " + thisJoinPoint.getSourceLocation());
* }
* }
*
*/
public interface JoinPoint {
String toString();
/**
* Returns an abbreviated string representation of the join point.
*/
String toShortString();
/**
* Returns an extended string representation of the join point.
*/
String toLongString();
/**
* Returns the currently executing object. This will always be
* the same object as that matched by the this pointcut
* designator. Unless you specifically need this reflective access,
* you should use the this pointcut designator to
* get at this object for better static typing and performance.
*
* Returns null when there is no currently executing object available.
* This includes all join points that occur in a static context.
*/
Object getThis();
/**
* Returns the target object. This will always be
* the same object as that matched by the target pointcut
* designator. Unless you specifically need this reflective access,
* you should use the target pointcut designator to
* get at this object for better static typing and performance.
*
* Returns null when there is no target object.
*/
Object getTarget();
/**
* Returns the arguments at this join point.
*/
Object[] getArgs();
/** Returns the signature at the join point.
*
* getStaticPart().getSignature() returns the same object
*/
Signature getSignature();
/** Returns the source location corresponding to the join point.
*
* If there is no source location available, returns null.
*
* Returns the SourceLocation of the defining class for default constructors.
*
* getStaticPart().getSourceLocation() returns the same object.
*/
SourceLocation getSourceLocation();
/** Returns a String representing the kind of join point. This
* String is guaranteed to be
* interned. getStaticPart().getKind() returns
* the same object.
*/
String getKind();
/**
* This helper object contains only the static information about a join point.
* It is available from the JoinPoint.getStaticPart() method, and
* can be accessed separately within advice using the special form
* thisJoinPointStaticPart.
*
* If you are only interested in the static information about a join point,
* you should access it through this type for the best performance. This
* is particularly useful for library methods that want to do serious
* manipulations of this information, i.e.
*
*
* public class LoggingUtils {
* public static void prettyPrint(JoinPoint.StaticPart jp) {
* ...
* }
* }
*
* aspect Logging {
* before(): ... { LoggingUtils.prettyPrint(thisJoinPointStaticPart); }
* }
*
*
* @see JoinPoint#getStaticPart()
*/
public interface StaticPart {
/** Returns the signature at the join point. */
Signature getSignature();
/** Returns the source location corresponding to the join point.
*
* If there is no source location available, returns null.
*
* Returns the SourceLocation of the defining class for default constructors.
*/
SourceLocation getSourceLocation();
/** Returns a String representing the kind of join point. This String
* is guaranteed to be interned
*/
String getKind();
/**
* Return the id for this JoinPoint.StaticPart. All JoinPoint.StaticPart
* instances are assigned an id number upon creation. For each advised type
* the id numbers start at 0.
*
* The id is guaranteed to remain constant across repeated executions
* of a program but may change if the code is recompiled.
*
* The benefit of having an id is that it can be used for array index
* purposes which can be quicker than using the JoinPoint.StaticPart
* object itself in a map lookup.
*
* Since two JoinPoint.StaticPart instances in different advised types may have
* the same id, then if the id is being used to index some joinpoint specific
* state then that state must be maintained on a pertype basis - either by
* using pertypewithin() or an ITD.
*
* @return the id of this joinpoint
*/
int getId();
String toString();
/**
* Returns an abbreviated string representation of the join point
*/
String toShortString();
/**
* Returns an extended string representation of the join point
*/
String toLongString();
}
public interface EnclosingStaticPart extends StaticPart {}
/**
* Returns an object that encapsulates the static parts of this join point.
*/
StaticPart getStaticPart();
/**
* The legal return values from getKind()
*/
static String METHOD_EXECUTION = "method-execution";
static String METHOD_CALL = "method-call";
static String CONSTRUCTOR_EXECUTION = "constructor-execution";
static String CONSTRUCTOR_CALL = "constructor-call";
static String FIELD_GET = "field-get";
static String FIELD_SET = "field-set";
static String STATICINITIALIZATION = "staticinitialization";
static String PREINITIALIZATION = "preinitialization";
static String INITIALIZATION = "initialization";
static String EXCEPTION_HANDLER = "exception-handler";
static String SYNCHRONIZATION_LOCK = "lock";
static String SYNCHRONIZATION_UNLOCK = "unlock";
static String ADVICE_EXECUTION = "adviceexecution";
}