org.kohsuke.accmod.impl
Interface Location


public interface Location

Indicates the location that the use occurred.

Author:
Kohsuke Kawaguchi

Method Summary
 java.lang.String getClassName()
          The fully-qualified class name in which the use happened, for example "abc.def.Ghi"
 java.lang.ClassLoader getDependencyClassLoader()
          AccessRestriction implementations can use this classloader to access the classes referenced by classes being inspected.
 int getLineNumber()
          The line number in the source file where the use happened.
 java.lang.String getMethodDescriptor()
          This is the encoded method signature like "(II)Z" in which the use happened.
 java.lang.String getMethodName()
          If the use happened in the byte code instruction, method name that the use occurred in.
 java.lang.String toString()
          Obtains a human readable description of the location.
 

Method Detail

getClassName

java.lang.String getClassName()
The fully-qualified class name in which the use happened, for example "abc.def.Ghi"


getMethodName

java.lang.String getMethodName()
If the use happened in the byte code instruction, method name that the use occurred in.

For example "getAbc"


getMethodDescriptor

java.lang.String getMethodDescriptor()
This is the encoded method signature like "(II)Z" in which the use happened. Used in conjunction with getMethodName() to disambiguate overload.


getLineNumber

int getLineNumber()
The line number in the source file where the use happened.


toString

java.lang.String toString()
Obtains a human readable description of the location. Useful for an error message.

Overrides:
toString in class java.lang.Object

getDependencyClassLoader

java.lang.ClassLoader getDependencyClassLoader()
AccessRestriction implementations can use this classloader to access the classes referenced by classes being inspected.

Loading a class has a side effect, so it's generally not recommended to do so, but the caller can use ClassLoader.getResource(String) and parse the class files via libraries like ASM to define more elaborate access restrictions.



Copyright © 2011. All Rights Reserved.