se.l4.lect.location

Class MutableTextOffsetLocation

java.lang.Object

se.l4.lect.location.MutableTextOffsetLocation

All Implemented Interfaces:

Comparable<Location>, Location, OffsetLocation, TextLocation, TextOffsetLocation

public class MutableTextOffsetLocation
extends Object
implements TextOffsetLocation

Mutable TextOffsetLocation for use in cases where both offset, line and column is important.

Author:

Andreas Holstenson

Constructor Summary

Constructors

Constructor and Description
MutableTextOffsetLocation(int offset, 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)
MutableTextOffsetLocation	copy() Copy this location.
MutableTextOffsetLocation	copyFrom(MutableTextOffsetLocation location)
boolean	equals(Object obj)
int	get() Get the offset.
int	getColumn() Get the column this location represents.
int	getLine() Get the line this location represents.
int	hashCode()
MutableTextOffsetLocation	moveTextIndex(CharSequence sequence) Move the text index according to the given sequence of characters.
MutableTextOffsetLocation	moveTextIndex(CharSequence sequence, int offset, int length) Move the text index according to the given sequence of characters.
MutableTextOffsetLocation	moveTextIndex(int amount) Create a version of this Location that has moved a number of positions in a text.
MutableTextOffsetLocation	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.
MutableTextOffsetLocation	moveTo(int offset, int line, int column) Move the offset, line and column of this location, returning either itself if mutable 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

MutableTextOffsetLocation

public MutableTextOffsetLocation(int offset,
                                 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

get

public int get()

Description copied from interface: OffsetLocation

Get the offset.

Specified by:

get in interface OffsetLocation

Returns:

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 MutableTextOffsetLocation moveTo(int offset,
                                        int line,
                                        int column)

Description copied from interface: TextOffsetLocation

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

Specified by:

moveTo in interface TextOffsetLocation

Returns:

new instance if immutable or self if mutable

moveTo

public MutableTextOffsetLocation 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 MutableTextOffsetLocation copyFrom(MutableTextOffsetLocation location)

copy

public MutableTextOffsetLocation copy()

Description copied from interface: TextOffsetLocation

Copy this location.

Specified by:

copy in interface Location

Specified by:

copy in interface OffsetLocation

Specified by:

copy in interface TextLocation

Specified by:

copy in interface TextOffsetLocation

Returns:

moveTextIndex

public MutableTextOffsetLocation moveTextIndex(int amount)

Description copied from interface: OffsetLocation

Create a version of this Location that has moved a number of positions in a text.

Specified by:

moveTextIndex in interface OffsetLocation

Returns:

moveTextIndex

public MutableTextOffsetLocation moveTextIndex(CharSequence sequence)

Description copied from interface: TextOffsetLocation

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 OffsetLocation

Specified by:

moveTextIndex in interface TextLocation

Specified by:

moveTextIndex in interface TextOffsetLocation

Returns:

moveTextIndex

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

Description copied from interface: TextOffsetLocation

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 OffsetLocation

Specified by:

moveTextIndex in interface TextLocation

Specified by:

moveTextIndex in interface TextOffsetLocation

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