org.aspectj.lang

Interface Signature

Known Subinterfaces:
AdviceSignature, CatchClauseSignature, CodeSignature, ConstructorSignature, FieldSignature, InitializerSignature, LockSignature, MemberSignature, MethodSignature, UnlockSignature
Known Implementing Classes:
FieldSignatureImpl

public interface Signature

Represents the signature at a join point. This interface parallels java.lang.reflect.Member.

This interface is typically used for tracing or logging applications to obtain reflective information about the join point, i.e. using the j2se 1.4 java.util.logging API

 aspect Logging {
     Logger logger = Logger.getLogger("MethodEntries");
 
     before(): within(com.bigboxco..*) && execution(public * *(..)) {
         Signature sig = thisJoinPoint.getSignature();
         logger.entering(sig.getDeclaringType().getName(),
                         sig.getName());
     }
 }
 

More detailed information about a specific kind of signature can be obtained by casting this Signature object into one of its more specific sub-types available in org.aspectj.lang.reflect.

See Also:
java.lang.reflect.Member, java.util.logging.Logger

Method Summary

Class
getDeclaringType()
Returns a java.lang.Class object representing the class, interface, or aspect that declared this member.
String
getDeclaringTypeName()
Returns the fully-qualified name of the declaring type.
int
getModifiers()
Returns the modifiers on this signature represented as an int.
String
getName()
Returns the identifier part of this signature.
String
toLongString()
Returns an extended string representation of this signature.
String
toShortString()
Returns an abbreviated string representation of this signature.
String
toString()

Method Details

getDeclaringType

public Class getDeclaringType()
Returns a java.lang.Class object representing the class, interface, or aspect that declared this member. For intra-member declarations, this will be the type on which the member is declared, not the type where the declaration is lexically written. Use SourceLocation.getWithinType() to get the type in which the declaration occurs lexically.

For consistency with java.lang.reflect.Member, this method should have been named getDeclaringClass().

See Also:
java.lang.reflect.Member.getDeclaringClass

getDeclaringTypeName

public String getDeclaringTypeName()
Returns the fully-qualified name of the declaring type. This is equivalent to calling getDeclaringType().getName(), but caches the result for greater efficiency.

getModifiers

public int getModifiers()
Returns the modifiers on this signature represented as an int. Use the constants and helper methods defined on java.lang.reflect.Modifier to manipulate this, i.e.
     // check if this signature is public
     java.lang.reflect.Modifier.isPublic(sig.getModifiers());
 
     // print out the modifiers
     java.lang.reflect.Modifier.toString(sig.getModifiers());
 
See Also:
java.lang.reflect.Member.getModifiers, java.lang.reflect.Modifier

getName

public String getName()
Returns the identifier part of this signature. For methods this will return the method name.
See Also:
java.lang.reflect.Member.getName

toLongString

public String toLongString()
Returns an extended string representation of this signature.

toShortString

public String toShortString()
Returns an abbreviated string representation of this signature.

toString

public String toString()