net.sourceforge.czt.z.ast

Interface LocAnn

All Superinterfaces:

Ann, Term

All Known Implementing Classes:

LocAnnImpl

public interface LocAnn
extends Ann

Location annotations define the source-code location of a construct. The Line and Col numbers, if present, refer to an identifying token within the construct, such as the equality token of an equality predicate, or the opening brace of a set comprehension. The Line and Col numbers start from (0,0), so may need adjusting to give correct positions in various editors. The Start number, if present, gives the position of the start of the construct from the beginning of the document (0 means the first character of the document), and the Length number gives the number of characters from the beginning of the construct to the end. The Length may be zero if the construct exists in one markup, but is not visible in another markup.

Author:

GnAST version 1.6-SNAPSHOT

Method Summary

Modifier and Type	Method and Description
BigInteger	getCol() Returns the Col element.
BigInteger	getEnd()
BigInteger	getLength() Returns the Length element.
BigInteger	getLine() Returns the Line element.
String	getLoc() Returns the Loc element.
BigInteger	getStart() Returns the Start element.
void	setCol(BigInteger col) Sets the Col element.
void	setLength(BigInteger length) Sets the Length element.
void	setLine(BigInteger line) Sets the Line element.
void	setLoc(String loc) Sets the Loc element.
void	setStart(BigInteger start) Sets the Start element.

Methods inherited from interface net.sourceforge.czt.base.ast.Term

accept, annsSize, create, getAnn, getAnns, getChildren, hasAnn, hasAnn, removeAnn, removeAnn

Method Detail

getLoc

String getLoc()

Returns the Loc element.

Returns:

the Loc element.

setLoc

void setLoc(String loc)

Sets the Loc element.

Parameters:

loc - the Loc element.

See Also:

getLoc()

getLine

BigInteger getLine()

Returns the Line element.

Returns:

the Line element.

setLine

void setLine(BigInteger line)

Sets the Line element.

Parameters:

line - the Line element.

See Also:

getLine()

getCol

BigInteger getCol()

Returns the Col element.

Returns:

the Col element.

setCol

void setCol(BigInteger col)

Sets the Col element.

Parameters:

col - the Col element.

See Also:

getCol()

getStart

BigInteger getStart()

Returns the Start element.

Returns:

the Start element.

setStart

void setStart(BigInteger start)

Sets the Start element.

Parameters:

start - the Start element.

See Also:

getStart()

getLength

BigInteger getLength()

Returns the Length element.

Returns:

the Length element.

setLength

void setLength(BigInteger length)

Sets the Length element.

Parameters:

length - the Length element.

See Also:

getLength()

getEnd

BigInteger getEnd()