fmrisc.ProgramExplorer.InOut

Class SourceAnnotationPosition

java.lang.Object

fmrisc.ProgramExplorer.InOut.SourceAnnotationPosition

All Implemented Interfaces:

SourcePosition

public final class SourceAnnotationPosition
extends java.lang.Object
implements SourcePosition

An annotation position in a source file with a position inside the annotation.

Constructor Summary

Constructors

Constructor and Description
SourceAnnotationPosition(SourceAnnotation annotation, int aline, int acolumn) Construct a source annotation position.

Method Summary

Modifier and Type	Method and Description
SourceAnnotation	getAnnotation() Get the annotation of the position.
int	getAnnotationColumn() Get the annotation column number of the position.
int	getAnnotationLine() Get the annotation number of the position.
int	getColumn() Get the column number of the position.
Identifier	getIdentifier() Get identifier registered with denoted position.
int	getLength() Get number of characters from current position to end of line.
int	getLine() Get the line number of the position.
int	getOffset() Get offset of the position.
Source	getSource() Get the source file.
java.lang.String	getSourceLine() Get source line corresponding to position.
void	setIdentifier(Identifier ident) Register identifier with denoted position.
java.lang.String	toString() Get printable text representation of position.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SourceAnnotationPosition

public SourceAnnotationPosition(SourceAnnotation annotation,
                                int aline,
                                int acolumn)

Construct a source annotation position.

Parameters:

annotation - the annotation

aline - the line number in the annotation (base 0)

acolumn - the column number in the annotation (base 0)

Method Detail

getAnnotation

public SourceAnnotation getAnnotation()

Get the annotation of the position.

Returns:

the annotation.

getAnnotationLine

public int getAnnotationLine()

Get the annotation number of the position.

Returns:

the line number.

getAnnotationColumn

public int getAnnotationColumn()

Get the annotation column number of the position.

Returns:

the column number.

getSource

public Source getSource()

Get the source file.

Specified by:

getSource in interface SourcePosition

Returns:

the source file.

getLine

public int getLine()

Get the line number of the position.

Specified by:

getLine in interface SourcePosition

Returns:

the line number.

getColumn

public int getColumn()

Get the column number of the position.

Specified by:

getColumn in interface SourcePosition

Returns:

the column number.

getOffset

public int getOffset()

Get offset of the position.

Specified by:

getOffset in interface SourcePosition

Returns:

the number of characters up to (excluding) the position denoted by the line and column index.

getLength

public int getLength()

Get number of characters from current position to end of line.

Specified by:

getLength in interface SourcePosition

Returns:

the number of characters.

toString

public java.lang.String toString()

Get printable text representation of position.

Specified by:

toString in interface SourcePosition

Overrides:

toString in class java.lang.Object

Returns:

the text representation.

getSourceLine

public java.lang.String getSourceLine()

Get source line corresponding to position.

Specified by:

getSourceLine in interface SourcePosition

Returns:

the source line of the position

setIdentifier

public void setIdentifier(Identifier ident)

Register identifier with denoted position.

Specified by:

setIdentifier in interface SourcePosition

Parameters:

ident - the identifier to be registered.

getIdentifier

public Identifier getIdentifier()

Get identifier registered with denoted position.

Specified by:

getIdentifier in interface SourcePosition

Returns:

the registered identifier (may be null).