Class DocumentRange

java.lang.Object
org.fife.ui.rsyntaxtextarea.DocumentRange
All Implemented Interfaces:
Comparable<DocumentRange>

public class DocumentRange extends Object implements Comparable<DocumentRange>
A range of text in a document.
Version:
1.0
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private int
     
    private int
     
  • Constructor Summary

    Constructors
    Constructor
    Description
    DocumentRange(int startOffs, int endOffs)
    Constructor.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Compares this document range to another.
    boolean
    equals(Object other)
    Returns whether this document range is equal to another one.
    int
    Gets the end offset of the range.
    int
    Gets the starting offset of the range.
    int
    Overridden simply as a best practice, since equals(Object) is overridden.
    boolean
    Returns whether this document range has zero length.
    void
    set(int start, int end)
    Sets the document range.
    Returns a string representation of this object.
    translate(int amount)
    Translates this document range by a given amount.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • startOffs

      private int startOffs
    • endOffs

      private int endOffs
  • Constructor Details

    • 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:
      IllegalArgumentException - If endOffs is less than startOffs, or either argument is less than zero.
  • Method Details

    • compareTo

      public int compareTo(DocumentRange other)
      Compares this document range to another.
      Specified by:
      compareTo in interface Comparable<DocumentRange>
      Parameters:
      other - Another document range.
      Returns:
      How the two should be sorted relative to each other.
    • equals

      public boolean equals(Object other)
      Returns whether this document range is equal to another one.
      Overrides:
      equals in class 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

      public int getStartOffset()
      Gets the starting offset of the range.
      Returns:
      The starting offset.
      See Also:
    • hashCode

      public int hashCode()
      Overridden simply as a best practice, since equals(Object) is overridden.
      Overrides:
      hashCode in class 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:
      IllegalArgumentException - If end is less than start, or either argument is less than zero.
    • toString

      public String toString()
      Returns a string representation of this object.
      Overrides:
      toString in class 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.