spoon.support.reflect.cu.position

Class SourcePositionImpl

java.lang.Object

spoon.support.reflect.cu.position.SourcePositionImpl

All Implemented Interfaces:

java.io.Serializable, SourcePosition

Direct Known Subclasses:

CompoundSourcePositionImpl

public class SourcePositionImpl
extends java.lang.Object
implements SourcePosition, java.io.Serializable

This immutable class represents the position of a Java program element in a source file.

See Also:

Serialized Form

Field Summary

Fields inherited from interface spoon.reflect.cu.SourcePosition

NOPOSITION

Constructor Summary

Constructors

Constructor and Description
SourcePositionImpl(CompilationUnit compilationUnit, int sourceStart, int sourceEnd, int[] lineSeparatorPositions)

Method Summary

Modifier and Type	Method and Description
protected static void	checkArgsAreAscending(int... values) fails when `values` are not sorted ascending It is used to check whether start/end values of SourcePosition are consistent
boolean	equals(java.lang.Object obj)
int	getColumn() Gets the column in the source file (1 indexed).
CompilationUnit	getCompilationUnit() Gets the compilation unit for this position.
int	getEndColumn() Gets the end column in the source file (1 indexed).
int	getEndLine() Gets the end line in the source file (1 indexed).
java.io.File	getFile() Gets the file for this position.
protected java.lang.String	getFragment(int start, int end)
int	getLine() Gets the line in the source file (1 indexed).
java.lang.String	getSourceDetails() Helper for debugging purposes.
int	getSourceEnd() Gets the index at which the position ends in the source file.
int	getSourceStart() Gets the index at which the position starts in the source file.
int	hashCode()
boolean	isValidPosition()
protected int	searchColumnNumber(int position) Search the column number
protected int	searchLineNumber(int position) Search the line number corresponding to a specific position
java.lang.String	toString() Returns a string representation of this position in the form "sourcefile:line", or "sourcefile" if no line number is available.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SourcePositionImpl

public SourcePositionImpl(CompilationUnit compilationUnit,
                          int sourceStart,
                          int sourceEnd,
                          int[] lineSeparatorPositions)

Method Detail

searchLineNumber

protected int searchLineNumber(int position)

Search the line number corresponding to a specific position

searchColumnNumber

protected int searchColumnNumber(int position)

Search the column number

isValidPosition

public boolean isValidPosition()

Specified by:

isValidPosition in interface SourcePosition

Returns:

true if this instance holds start/end indexes of related sources. false if they are unknown

getColumn

public int getColumn()

Description copied from interface: SourcePosition

Gets the column in the source file (1 indexed). This method is slow because it has to calculate the column number depending on Environment.getTabulationSize() and CtCompilationUnit.getOriginalSourceCode(). Prefer SourcePosition.getSourceStart().

Specified by:

getColumn in interface SourcePosition

getEndColumn

public int getEndColumn()

Description copied from interface: SourcePosition

Gets the end column in the source file (1 indexed). This method is slow because it has to calculate the column number depending on Environment.getTabulationSize() and CtCompilationUnit.getOriginalSourceCode(). Prefer SourcePosition.getSourceEnd().

Specified by:

getEndColumn in interface SourcePosition

getFile

public java.io.File getFile()

Description copied from interface: SourcePosition

Gets the file for this position.

Specified by:

getFile in interface SourcePosition

getLine

public int getLine()

Description copied from interface: SourcePosition

Gets the line in the source file (1 indexed). Prefer using SourcePosition.getSourceStart()}. For CtNamedElement the line is where the name is declared.

Specified by:

getLine in interface SourcePosition

getEndLine

public int getEndLine()

Description copied from interface: SourcePosition

Gets the end line in the source file (1 indexed). Prefer using SourcePosition.getSourceEnd()}.

Specified by:

getEndLine in interface SourcePosition

getSourceEnd

public int getSourceEnd()

Description copied from interface: SourcePosition

Gets the index at which the position ends in the source file. Heavily used for the sniper mode.

Specified by:

getSourceEnd in interface SourcePosition

getSourceStart

public int getSourceStart()

Description copied from interface: SourcePosition

Gets the index at which the position starts in the source file.

Specified by:

getSourceStart in interface SourcePosition

toString

public java.lang.String toString()

Returns a string representation of this position in the form "sourcefile:line", or "sourcefile" if no line number is available.

Specified by:

toString in interface SourcePosition

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getCompilationUnit

public CompilationUnit getCompilationUnit()

Description copied from interface: SourcePosition

Gets the compilation unit for this position.

Specified by:

getCompilationUnit in interface SourcePosition

getSourceDetails

public java.lang.String getSourceDetails()

Helper for debugging purposes. Displays |startIndex; endIndex|sourceCode| of this SourcePosition If this instance is DeclarationSourcePosition or BodyHolderSourcePosition Then details about name, modifiers and body are included in resulting string too

Returns:

details about source code of this SourcePosition

getFragment

protected java.lang.String getFragment(int start,
                                       int end)

checkArgsAreAscending

protected static void checkArgsAreAscending(int... values)

fails when `values` are not sorted ascending It is used to check whether start/end values of SourcePosition are consistent