Package com.intellij.openapi.util

Class TextRange

java.lang.Object

com.intellij.openapi.util.TextRange

All Implemented Interfaces:

Segment, java.io.Serializable

Direct Known Subclasses:

FindResult, ProperTextRange, UnfairTextRange

public class TextRange
extends java.lang.Object
implements Segment, java.io.Serializable

A text range defined by start and end (exclusive) offset.

See Also:

ProperTextRange, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static TextRange[]	EMPTY_ARRAY
static TextRange	EMPTY_RANGE

Fields inherited from interface com.intellij.openapi.util.Segment

BY_START_OFFSET_THEN_END_OFFSET

Constructor Summary

Constructors

Modifier	Constructor and Description
	TextRange(int startOffset, int endOffset)
protected	TextRange(int startOffset, int endOffset, boolean checkForProperTextRange)

Method Summary

Modifier and Type	Method and Description
static TextRange	allOf(java.lang.String s)
static boolean	areSegmentsEqual(Segment segment1, Segment segment2)
static void	assertProperRange(int startOffset, int endOffset, java.lang.Object message)
static void	assertProperRange(Segment range)
static void	assertProperRange(Segment range, java.lang.Object message)
boolean	contains(int offset)
boolean	contains(Segment range)
boolean	contains(TextRange range)
boolean	containsOffset(int offset)
boolean	containsRange(int startOffset, int endOffset)
static boolean	containsRange(Segment outer, Segment inner)
static TextRange	create(int startOffset, int endOffset)
static TextRange	create(Segment segment)
TextRange	cutOut(TextRange subRange)
boolean	equals(java.lang.Object obj)
boolean	equalsToRange(int startOffset, int endOffset)
static TextRange	from(int offset, int length)
int	getEndOffset()
int	getLength()
int	getStartOffset()
TextRange	grown(int lengthDelta)
int	hashCode()
TextRange	intersection(TextRange range)
boolean	intersects(int startOffset, int endOffset)
boolean	intersects(Segment textRange)
boolean	intersects(TextRange textRange)
boolean	intersectsStrict(int startOffset, int endOffset)
boolean	intersectsStrict(TextRange textRange)
boolean	isEmpty()
java.lang.String	replace(java.lang.String original, java.lang.String replacement)
TextRange	shiftLeft(int delta)
TextRange	shiftRight(int delta)
java.lang.CharSequence	subSequence(java.lang.CharSequence str)
java.lang.String	substring(java.lang.String str)
java.lang.String	toString()
TextRange	union(TextRange textRange)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_RANGE

public static final TextRange EMPTY_RANGE

EMPTY_ARRAY

public static final TextRange[] EMPTY_ARRAY

Constructor Detail

TextRange

public TextRange(int startOffset,
                 int endOffset)

See Also:

create(int, int), from(int, int), allOf(String)

TextRange

protected TextRange(int startOffset,
                    int endOffset,
                    boolean checkForProperTextRange)

Parameters:

checkForProperTextRange - true if offsets should be checked by assertProperRange(int, int, Object)

See Also:

UnfairTextRange

Method Detail

getStartOffset

public final int getStartOffset()

Specified by:

getStartOffset in interface Segment

getEndOffset

public final int getEndOffset()

Specified by:

getEndOffset in interface Segment

getLength

public final int getLength()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

contains

public boolean contains(TextRange range)

contains

public boolean contains(Segment range)

containsRange

public boolean containsRange(int startOffset,
                             int endOffset)

containsRange

public static boolean containsRange(Segment outer,
                                    Segment inner)

containsOffset

public boolean containsOffset(int offset)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

contains

public boolean contains(int offset)

substring

public java.lang.String substring(java.lang.String str)

subSequence

public java.lang.CharSequence subSequence(java.lang.CharSequence str)

cutOut

public TextRange cutOut(TextRange subRange)

shiftRight

public TextRange shiftRight(int delta)

shiftLeft

public TextRange shiftLeft(int delta)

grown

public TextRange grown(int lengthDelta)

from

public static TextRange from(int offset,
                             int length)

create

public static TextRange create(int startOffset,
                               int endOffset)

create

public static TextRange create(Segment segment)

areSegmentsEqual

public static boolean areSegmentsEqual(Segment segment1,
                                       Segment segment2)

replace

public java.lang.String replace(java.lang.String original,
                                java.lang.String replacement)

intersects

public boolean intersects(TextRange textRange)

intersects

public boolean intersects(Segment textRange)

intersects

public boolean intersects(int startOffset,
                          int endOffset)

intersectsStrict

public boolean intersectsStrict(TextRange textRange)

intersectsStrict

public boolean intersectsStrict(int startOffset,
                                int endOffset)

intersection

public TextRange intersection(TextRange range)

isEmpty

public boolean isEmpty()

union

public TextRange union(TextRange textRange)

equalsToRange

public boolean equalsToRange(int startOffset,
                             int endOffset)

allOf

public static TextRange allOf(java.lang.String s)

assertProperRange

public static void assertProperRange(Segment range)
                              throws java.lang.AssertionError

Throws:

java.lang.AssertionError

assertProperRange

public static void assertProperRange(Segment range,
                                     java.lang.Object message)
                              throws java.lang.AssertionError

Throws:

java.lang.AssertionError

assertProperRange

public static void assertProperRange(int startOffset,
                                     int endOffset,
                                     java.lang.Object message)