se.l4.lect.location

Interface Location

All Superinterfaces:

Comparable<Location>

All Known Subinterfaces:

OffsetLocation, TextLocation, TextOffsetLocation

All Known Implementing Classes:

MutableOffsetLocation, MutableTextLocation, MutableTextOffsetLocation

public interface Location
extends Comparable<Location>

Virtual representation of the location of something in a TextSource. This interface exists so that sources may potentially include location info that are not just suitable for plain text.

Author:

Andreas Holstenson

Method Summary

Modifier and Type	Method and Description
Location	copy() Create a copy of this location.
default boolean	isAfter(Location other) Get if this location comes after another location.
default boolean	isBefore(Location other) Get if this location comes before another location.
default boolean	isSameOrAfter(Location other) Get if this location is the same or after another location.
default boolean	isSameOrBefore(Location other) Get if this location is the same or before another location.
Location	moveTextIndex(CharSequence sequence) Move the text index according to the given sequence of characters.
Location	moveTextIndex(CharSequence sequence, int offset, int length) Move the text index according to the given sequence of characters.
static OffsetLocation	offset(int index) Quickly create a new MutableOffsetLocation.
static TextLocation	text(int offset, int line, int column) Quickly create a new MutableTextOffsetLocation.
String	toString() Return a string representation of this location suitable for debugging output, such as in log messages.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

toString

String toString()

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

Overrides:

toString in class Object

Returns:

copy

Location copy()

Create a copy of this location.

Returns:

isAfter

default boolean isAfter(Location other)

Get if this location comes after another location.

Parameters:

other -

Returns:

isSameOrAfter

default boolean isSameOrAfter(Location other)

Get if this location is the same or after another location.

Parameters:

other -

Returns:

isBefore

default boolean isBefore(Location other)

Get if this location comes before another location.

Parameters:

other -

Returns:

isSameOrBefore

default boolean isSameOrBefore(Location other)

Get if this location is the same or before another location.

Parameters:

other -

Returns:

moveTextIndex

Location moveTextIndex(CharSequence sequence)

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

Parameters:

sequence -

Returns:

moveTextIndex

Location moveTextIndex(CharSequence sequence,
                       int offset,
                       int length)

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

Parameters:

sequence -

offset -

length -

Returns:

text

static TextLocation text(int offset,
                         int line,
                         int column)

Quickly create a new MutableTextOffsetLocation.

Parameters:

line -

column -

Returns:

offset

static OffsetLocation offset(int index)

Quickly create a new MutableOffsetLocation.

Parameters:

index -

Returns: