Package ortus.boxlang.compiler.ast

Class Position

java.lang.Object

ortus.boxlang.compiler.ast.Position

All Implemented Interfaces:

Serializable

public class Position
extends Object
implements Serializable

Represents a region of code within a text

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Position(Point start, Point end)	Creates a position
Position(Point start, Point end, Source source)	Creates a position including the file information

Method Summary

Modifier and Type	Method	Description
Point	getEnd()	Returns the end point
Source	getSource()	Returns the source of the position
Point	getStart()	Returns the start point
void	setEnd(Point end)	Set the end point
void	setSource(Source source)	Set the source of the position
void	setStart(Point start)	Set the end point
Map<String,Object>	toMap()
String	toString()	String representation of the Position

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Position

public Position(Point start,
 Point end)

Creates a position

Parameters:

start - the start position in the source code

end - the end position in the source code

Position

public Position(Point start,
 Point end,
 Source source)

Creates a position including the file information

Parameters:

start - the start position in the source code

end - the end position in the source code

source - the source file reference

Method Details

getStart

public Point getStart()

Returns the start point

Returns:

the start point of the region

getEnd

public Point getEnd()

Returns the end point

Returns:

the end point of the region

setEnd

public void setEnd(Point end)

Set the end point

Parameters:

end - the end point of the region

setStart

public void setStart(Point start)

Set the end point

Parameters:

start - the end point of the region

getSource

public Source getSource()

Returns the source of the position

Returns:

the start point of the region

See Also:

• Source

setSource

public void setSource(Source source)

Set the source of the position

Parameters:

source - The source of the position (i.e. file)

See Also:

• Source

toString

public String toString()

String representation of the Position

Overrides:

toString in class Object

Returns:

a String representation of the position including the source file if available

toMap

public Map<String,Object> toMap()