001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package org.netbeans.modules.gsf.api;
042:
043: /**
044: * An offset range provides a range (start, end) pair of offsets
045: * that indicate a range in a character buffer. The range represented
046: * is {@code [start,end>}, which means that the range includes the
047: * character at index=start, and ends right before the character at end.
048: * Put yet another way, the starting offset is inclusive, and the ending
049: * offset is exclusive.
050: *
051: * @author Tor Norbye
052: */
053: public class OffsetRange {
054: public static final OffsetRange NONE = new OffsetRange(0, 0);
055: private final int start;
056: private final int end;
057:
058: /** Creates a new instance of OffsetRange */
059: public OffsetRange(int start, int end) {
060: assert start >= 0;
061: assert end >= start;
062:
063: this .start = start;
064: this .end = end;
065: }
066:
067: /** Get the start offset of offset range */
068: public int getStart() {
069: return start;
070: }
071:
072: /** Get the end offset of offset range */
073: public int getEnd() {
074: return end;
075: }
076:
077: /** Get the length of the offset range */
078: public int getLength() {
079: return getEnd() - getStart();
080: }
081:
082: @Override
083: public String toString() {
084: if (this == NONE) {
085: return "OffsetRange[NONE]";
086: } else {
087: return "OffsetRange[" + start + "," + end + ">"; // NOI18N
088: }
089: }
090:
091: @Override
092: public boolean equals(Object o) {
093: if (o == null) {
094: return false;
095: }
096:
097: if (getClass() != o.getClass()) {
098: return false;
099: }
100:
101: final OffsetRange test = (OffsetRange) o;
102:
103: if (this .getStart() != test.getStart()) {
104: return false;
105: }
106:
107: if (this .getEnd() != test.getEnd()) {
108: return false;
109: }
110:
111: return true;
112: }
113:
114: @Override
115: public int hashCode() {
116: int hash = 7;
117:
118: hash = (23 * hash) + this .getStart();
119: hash = (23 * hash) + this .getEnd();
120:
121: return hash;
122: }
123:
124: /** Return true iff the given offset is within the bounds (or at the bounds) of the range */
125: public boolean containsInclusive(int offset) {
126: if (this == NONE) {
127: return false;
128: }
129:
130: return (offset >= getStart()) && (offset <= getEnd());
131: }
132: }
|