net.sourceforge.czt.text

Class Position

java.lang.Object

net.sourceforge.czt.text.Position

public class Position
extends Object

Positions describe text ranges of a document. The text range is specified by an offset and a length.

This is an immutable value object.

Author:

Andrius Velykis

Field Summary

Fields

Modifier and Type	Field and Description
int	length The length of the position
int	offset The offset of the position

Constructor Summary

Constructors

Constructor and Description
Position(int offset) Creates a new position with the given offset and length 0.
Position(int offset, int length) Creates a new position with the given offset and length.

Method Summary

Modifier and Type	Method and Description
static Position	createStartEnd(int start, int end) Static factory method to create a position based on its start and end offsets.
boolean	equals(Object obj)
int	getEndOffset() Calculates the end offset of this position.
int	getLength() Returns the length of this position.
int	getOffset() Returns the offset of this position.
int	hashCode()
boolean	overlapsWith(int rangeOffset, int rangeLength) Checks whether the intersection of the given text range and the text range represented by this position is empty or not.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

offset

public final int offset

The offset of the position

length

public final int length

The length of the position

Constructor Detail

Position

public Position(int offset)

Creates a new position with the given offset and length 0.

Parameters:

offset - the position offset, must be >= 0

Position

public Position(int offset,
                int length)

Creates a new position with the given offset and length.

Parameters:

offset - the position offset, must be >= 0

length - the position length, must be >= 0

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getLength

public int getLength()

Returns the length of this position.

Returns:

the length of this position

getOffset

public int getOffset()

Returns the offset of this position.

Returns:

the offset of this position

getEndOffset

public int getEndOffset()

Calculates the end offset of this position.

Returns:

the end offset of this position (point after the range).

overlapsWith

public boolean overlapsWith(int rangeOffset,
                            int rangeLength)

Checks whether the intersection of the given text range and the text range represented by this position is empty or not.

Parameters:

rangeOffset - the offset of the range to check

rangeLength - the length of the range to check

Returns:

true if intersection is not empty

toString

public String toString()

Overrides:

toString in class Object

createStartEnd

public static Position createStartEnd(int start,
                                      int end)

Static factory method to create a position based on its start and end offsets.

Parameters:

start - the start offset of the position

end - the end offset of the position

Returns:

new position with the given start and end offsets