Package org.eclipse.jface.text
Class Position
java.lang.Object
org.eclipse.jface.text.Position
- Direct Known Subclasses:
Fragment
,LinkedPosition
,Segment
,TypedPosition
Positions describe text ranges of a document. Positions are adapted to
changes applied to that document. The text range is specified by an offset
and a length. Positions can be marked as deleted. Deleted positions are
considered to no longer represent a valid text range in the managing
document.
Positions attached to documents are usually updated by position updaters. Because position updaters are freely definable and because of the frequency in which they are used, the fields of a position are made publicly accessible. Clients other than position updaters are not allowed to access these public fields.
Positions cannot be used as keys in hash tables as they override
equals
and hashCode
as they would be value
objects.
- See Also:
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
Marks this position as deleted.boolean
int
Returns the length of this position.int
Returns the offset of this position.int
hashCode()
boolean
includes
(int index) Checks whether the given index is inside of this position's text range.boolean
Returns whether this position has been deleted or not.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.void
setLength
(int length) Changes the length of this position to the given length.void
setOffset
(int offset) Changes the offset of this position to the given offset.toString()
void
undelete()
Marks this position as not deleted.
-
Field Details
-
offset
public int offsetThe offset of the position -
length
public int lengthThe length of the position -
isDeleted
public boolean isDeletedIndicates whether the position has been deleted
-
-
Constructor Details
-
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 >= 0length
- the position length, must be >= 0
-
Position
protected Position()Creates a new, not initialized position.
-
-
Method Details
-
hashCode
public int hashCode() -
delete
public void delete()Marks this position as deleted. -
undelete
public void undelete()Marks this position as not deleted.- Since:
- 2.0
-
equals
-
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
-
includes
public boolean includes(int index) Checks whether the given index is inside of this position's text range.- Parameters:
index
- the index to check- Returns:
true
ifindex
is inside of this position
-
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 checkrangeLength
- the length of the range to check- Returns:
true
if intersection is not empty
-
isDeleted
public boolean isDeleted()Returns whether this position has been deleted or not.- Returns:
true
if position has been deleted
-
setLength
public void setLength(int length) Changes the length of this position to the given length.- Parameters:
length
- the new length of this position
-
setOffset
public void setOffset(int offset) Changes the offset of this position to the given offset.- Parameters:
offset
- the new offset of this position
-
toString
-