se.l4.lect.location

Class MutableTextLocation

java.lang.Object

se.l4.lect.location.MutableTextLocation

All Implemented Interfaces:

Comparable<Location>, Location, TextLocation

public class MutableTextLocation
extends Object
implements TextLocation

Mutable TextLocation for use in cases where line and column is important.

Author:

Andreas Holstenson

Constructor Summary

Constructors

Constructor and Description
MutableTextLocation(int line, int column) Create a new location representing the given line and column.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Location o)
MutableTextLocation	copy() Create a copy of this location.
TextLocation	copyFrom(TextLocation location)
boolean	equals(Object obj)
int	getColumn() Get the column this location represents.
int	getLine() Get the line this location represents.
int	hashCode()
MutableTextLocation	moveTextIndex(CharSequence sequence) Move the text index according to the given sequence of characters.
MutableTextLocation	moveTextIndex(CharSequence sequence, int offset, int length) Move the text index according to the given sequence of characters.
MutableTextLocation	moveTo(int line, int column) Move the line and column of this location, returning either itself if utable or a copy if this instance is immutable.
String	toString() Return a string representation of this location suitable for debugging output, such as in log messages.

Methods inherited from class java.lang.Object

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

Methods inherited from interface se.l4.lect.location.Location

isAfter, isBefore, isSameOrAfter, isSameOrBefore, offset, text

Constructor Detail

MutableTextLocation

public MutableTextLocation(int line,
                           int column)

Create a new location representing the given line and column.

Parameters:

line - zero-indexed line

column - zero-indexed column

Method Detail

getLine

public int getLine()

Description copied from interface: TextLocation

Get the line this location represents.

Specified by:

getLine in interface TextLocation

Returns:

zero-indexed line

getColumn

public int getColumn()

Description copied from interface: TextLocation

Get the column this location represents.

Specified by:

getColumn in interface TextLocation

Returns:

moveTo

public MutableTextLocation moveTo(int line,
                                  int column)

Description copied from interface: TextLocation

Move the line and column of this location, returning either itself if utable or a copy if this instance is immutable.

Specified by:

moveTo in interface TextLocation

Returns:

copyFrom

public TextLocation copyFrom(TextLocation location)

copy

public MutableTextLocation copy()

Description copied from interface: TextLocation

Create a copy of this location.

Specified by:

copy in interface Location

Specified by:

copy in interface TextLocation

Returns:

moveTextIndex

public MutableTextLocation moveTextIndex(CharSequence sequence)

Description copied from interface: TextLocation

Move the text index according to the given sequence of characters. Returns itself if mutable or a copy if the instance is immutable.

Specified by:

moveTextIndex in interface Location

Specified by:

moveTextIndex in interface TextLocation

Returns:

moveTextIndex

public MutableTextLocation moveTextIndex(CharSequence sequence,
                                         int offset,
                                         int length)

Description copied from interface: TextLocation

Move the text index according to the given sequence of characters. Returns itself if mutable or a copy if the instance is immutable.

Specified by:

moveTextIndex in interface Location

Specified by:

moveTextIndex in interface TextLocation

Returns:

compareTo

public int compareTo(Location o)

Specified by:

compareTo in interface Comparable<Location>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Description copied from interface: Location

Return a string representation of this location suitable for debugging output, such as in log messages.

Specified by:

toString in interface Location

Overrides:

toString in class Object