Package org.fife.ui.rsyntaxtextarea
Class DocumentRange
- java.lang.Object
-
- org.fife.ui.rsyntaxtextarea.DocumentRange
-
- All Implemented Interfaces:
java.lang.Comparable<DocumentRange>
public class DocumentRange extends java.lang.Object implements java.lang.Comparable<DocumentRange>
A range of text in a document.- Version:
- 1.0
-
-
Constructor Summary
Constructors Constructor Description DocumentRange(int startOffs, int endOffs)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(DocumentRange other)
Compares this document range to another.boolean
equals(java.lang.Object other)
Returns whether this document range is equal to another one.int
getEndOffset()
Gets the end offset of the range.int
getStartOffset()
Gets the starting offset of the range.int
hashCode()
Overridden simply as a best practice, sinceequals(Object)
is overridden.boolean
isZeroLength()
Returns whether this document range has zero length.void
set(int start, int end)
Sets the document range.java.lang.String
toString()
Returns a string representation of this object.DocumentRange
translate(int amount)
Translates this document range by a given amount.
-
-
-
Constructor Detail
-
DocumentRange
public DocumentRange(int startOffs, int endOffs)
Constructor.- Parameters:
startOffs
- The starting offset in the document, inclusive.endOffs
- The ending offset in the document, exclusive.- Throws:
java.lang.IllegalArgumentException
- IfendOffs
is less thanstartOffs
, or either argument is less than zero.
-
-
Method Detail
-
compareTo
public int compareTo(DocumentRange other)
Compares this document range to another.- Specified by:
compareTo
in interfacejava.lang.Comparable<DocumentRange>
- Parameters:
other
- Another document range.- Returns:
- How the two should be sorted relative to each other.
-
equals
public boolean equals(java.lang.Object other)
Returns whether this document range is equal to another one.- Overrides:
equals
in classjava.lang.Object
- Parameters:
other
- Another object, presumably a document range.- Returns:
- Whether
other
is also a document range, and equal to this one.
-
getEndOffset
public int getEndOffset()
Gets the end offset of the range.- Returns:
- The end offset.
- See Also:
getStartOffset()
-
getStartOffset
public int getStartOffset()
Gets the starting offset of the range.- Returns:
- The starting offset.
- See Also:
getEndOffset()
-
hashCode
public int hashCode()
Overridden simply as a best practice, sinceequals(Object)
is overridden.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- The hash code for this object.
-
isZeroLength
public boolean isZeroLength()
Returns whether this document range has zero length. This can happen, for example, with regex searches of forms like"foo|"
, where the right-hand sub-expression matches empty strings.- Returns:
- Whether this document range has zero length.
-
set
public void set(int start, int end)
Sets the document range.- Parameters:
start
- The new start value, inclusive.end
- The new end value, exclusive.- Throws:
java.lang.IllegalArgumentException
- Ifend
is less thanstart
, or either argument is less than zero.
-
toString
public java.lang.String toString()
Returns a string representation of this object.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this object.
-
translate
public DocumentRange translate(int amount)
Translates this document range by a given amount.- Parameters:
amount
- The amount to translate this range by.- Returns:
- This (modified) range.
-
-