spoon.reflect.cu.position

Class NoSourcePosition

java.lang.Object

spoon.reflect.cu.position.NoSourcePosition

All Implemented Interfaces:

java.io.Serializable, SourcePosition

Direct Known Subclasses:

PartialSourcePositionImpl

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NoSourcePosition.NullCompilationUnit

Field Summary

Fields inherited from interface spoon.reflect.cu.SourcePosition

NOPOSITION

Constructor Summary

Constructors

Constructor and Description
NoSourcePosition()

Method Summary

Modifier and Type	Method and Description
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.
int	getLine() Gets the line in the source file (1 indexed).
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.
boolean	isValidPosition()
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NoSourcePosition

public NoSourcePosition()

Method Detail

getFile

public java.io.File getFile()

Description copied from interface: SourcePosition

Gets the file for this position.

Specified by:

getFile in interface SourcePosition

getCompilationUnit

public CompilationUnit getCompilationUnit()

Description copied from interface: SourcePosition

Gets the compilation unit for this position.

Specified by:

getCompilationUnit in interface SourcePosition

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

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

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

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()

Description copied from interface: SourcePosition

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