Top Description Fields Methods

org.aspectj.bridge

public Interface ISourceLocation

Known Direct Implementers: org.aspectj.bridge.SourceLocation
Imports: java.io.File

Represent source location as a starting line/column and ending line in a source file. Implementations should be immutable. XXX why?

See Also: org.aspectj.lang.reflect.SourceLocation

Field Summary

Modifier and Type	Field and Description
public static final ISourceLocation	EMPTY non-null but empty constant source location
public static final int	MAX_COLUMN
public static final int	MAX_LINE
public static final int	NO_COLUMN signal that column is not known
public static final File	NO_FILE non-null but empty (nonexisting) File constant

Method Summary

Modifier and Type	Method and Description
public int	Returns: int 0..MAX_COLUMN actual column or 0 if column input was ISourceLocation.NO_COLUMN getColumn()
public String	Returns: String application-specific context for source getContext()
public int	Returns: getLine()..MAX_LINE getEndLine()
public int	Returns: 0..MAX_LINE getLine()
public int	Returns: offset into file getOffset()
public File	Returns: File source or NO_FILE if the implementation requires a non-null result or null otherwise getSourceFile()
public String	Returns: the name of the source file getSourceFileName() In the cases where getSourceFile().getName() returns a class file (for example when we have a binary aspect) this should return the name of the source file (for example BinaryAspect.aj)

Field Detail

EMPTY	back to summary
public static final ISourceLocation EMPTY non-null but empty constant source location

MAX_COLUMN	back to summary
public static final int MAX_COLUMN

MAX_LINE	back to summary
public static final int MAX_LINE

NO_COLUMN	back to summary
public static final int NO_COLUMN signal that column is not known

NO_FILE	back to summary
public static final File NO_FILE non-null but empty (nonexisting) File constant

Method Detail

getColumn	back to summary
public int getColumn() Returns:int int 0..MAX_COLUMN actual column or 0 if column input was ISourceLocation.NO_COLUMN

getContext	back to summary
public String getContext() Returns:String String application-specific context for source

getEndLine	back to summary
public int getEndLine() Returns:int getLine()..MAX_LINE

getLine	back to summary
public int getLine() Returns:int 0..MAX_LINE

getOffset	back to summary
public int getOffset() Returns:int offset into file

getSourceFile	back to summary
public File getSourceFile() Returns:File File source or NO_FILE if the implementation requires a non-null result or null otherwise

getSourceFileName

back to summary

public String getSourceFileName()

In the cases where getSourceFile().getName() returns a class file (for example when we have a binary aspect) this should return the name of the source file (for example BinaryAspect.aj)

Returns:String: the name of the source file