public class Position extends Object
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.
IDocument
Modifier and Type | Field and Description |
---|---|
boolean |
isDeleted
Indicates whether the position has been deleted
|
int |
length
The length of the position
|
int |
offset
The offset of the position
|
Modifier | Constructor and Description |
---|---|
protected |
Position()
Creates a new, not initialized position.
|
|
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.
|
Modifier and Type | Method and Description |
---|---|
void |
delete()
Marks this position as deleted.
|
boolean |
equals(Object other) |
int |
getLength()
Returns the length of this position.
|
int |
getOffset()
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 |
isDeleted()
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.
|
String |
toString() |
void |
undelete()
Marks this position as not deleted.
|
public int offset
public int length
public boolean isDeleted
public Position(int offset)
offset
- the position offset, must be >= 0public Position(int offset, int length)
offset
- the position offset, must be >= 0length
- the position length, must be >= 0protected Position()
public void delete()
public void undelete()
public int getLength()
public int getOffset()
public boolean includes(int index)
index
- the index to checktrue
if index
is inside of this positionpublic boolean overlapsWith(int rangeOffset, int rangeLength)
rangeOffset
- the offset of the range to checkrangeLength
- the length of the range to checktrue
if intersection is not emptypublic boolean isDeleted()
true
if position has been deletedpublic void setLength(int length)
length
- the new length of this positionpublic void setOffset(int offset)
offset
- the new offset of this position
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.