org.fife.ui.rsyntaxtextarea.DocumentRange Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of rsyntaxtextarea Show documentation

RSyntaxTextArea is the syntax highlighting text editor for Swing applications. Features include syntax highlighting for 40+ languages, code folding, code completion, regex find and replace, macros, code templates, undo/redo, line numbering and bracket matching.

There is a newer version: 3.5.1

Show newest version

/*
 * 08/11/2009
 *
 * DocumentRange.java - A range of text in a document.
 *
 * This library is distributed under a modified BSD license.  See the included
 * LICENSE file for details.
 */
package org.fife.ui.rsyntaxtextarea;


/**
 * A range of text in a document.
 *
 * @author Robert Futrell
 * @version 1.0
 */
public class DocumentRange implements Comparable {

	private int startOffs;
	private int endOffs;


	/**
	 * Constructor.
	 *
	 * @param startOffs The starting offset in the document, inclusive.
	 * @param endOffs The ending offset in the document, exclusive.
	 * @throws IllegalArgumentException If endOffs is less than
	 *         startOffs, or either argument is less than zero.
	 */
	public DocumentRange(int startOffs, int endOffs) {
		set(startOffs, endOffs);
	}


	/**
	 * Compares this document range to another.
	 *
	 * @param other Another document range.
	 * @return How the two should be sorted relative to each other.
	 */
	@Override
	public int compareTo(DocumentRange other) {
		if (other==null) {
			return 1;
		}
		int diff = startOffs - other.startOffs;
		if (diff!=0) {
			return diff;
		}
		return endOffs - other.endOffs;
	}


	/**
	 * Returns whether this document range is equal to another one.
	 *
	 * @param other Another object, presumably a document range.
	 * @return Whether other is also a document range, and equal
	 *         to this one.
	 */
	@Override
	public boolean equals(Object other) {
		if (other==this) {
			return true;
		}
		if (other instanceof DocumentRange) {
			return this.compareTo((DocumentRange)other)==0;
		}
		return false;
	}


	/**
	 * Gets the end offset of the range.
	 *
	 * @return The end offset.
	 * @see #getStartOffset()
	 */
	public int getEndOffset() {
		return endOffs;
	}


	/**
	 * Gets the starting offset of the range.
	 *
	 * @return The starting offset.
	 * @see #getEndOffset()
	 */
	public int getStartOffset() {
		return startOffs;
	}


	/**
	 * Overridden simply as a best practice, since {@link #equals(Object)} is
	 * overridden.
	 *
	 * @return The hash code for this object.
	 */
	@Override
	public int hashCode() {
		return startOffs + endOffs;
	}


	/**
	 * 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.
	 *
	 * @return Whether this document range has zero length.
	 */
	public boolean isZeroLength() {
		return startOffs == endOffs;
	}


	/**
	 * Sets the document range.
	 *
	 * @param start The new start value, inclusive.
	 * @param end The new end value, exclusive.
	 * @throws IllegalArgumentException If end is less than
	 *         start, or either argument is less than zero.
	 */
	public void set(int start, int end) {
		if (start<0 || end<0) {
			throw new IllegalArgumentException(
					"start and end must be >= 0 (" + start + "-" + end + ")");
		}
		if (end