Module aya.ij.util.text

Package com.intellij.openapi.util

Class TextRange

java.lang.Object

com.intellij.openapi.util.TextRange

All Implemented Interfaces:

Segment, Serializable

public class TextRange
extends Object
implements Segment, Serializable

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

See Also:

• ProperTextRange
• com.intellij.util.text.TextRangeUtil
• Serialized Form

Field Summary

Fields

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

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

BY_START_OFFSET_THEN_END_OFFSET

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_RANGE

public static final TextRange EMPTY_RANGE

EMPTY_ARRAY

public static final TextRange[] EMPTY_ARRAY

Constructor Details

TextRange

@Contract(pure=true)
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 Details

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(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

contains

public boolean contains(@NotNull
 @NotNull TextRange range)

contains

public boolean contains(@NotNull
 @NotNull Segment range)

containsRange

public boolean containsRange(int startOffset,
 int endOffset)

containsRange

public static boolean containsRange(@NotNull
 @NotNull Segment outer,
 @NotNull
 @NotNull Segment inner)

containsOffset

public boolean containsOffset(int offset)

toString

public String toString()

Overrides:

toString in class Object

contains

public boolean contains(int offset)

substring

@NotNull
@Contract(pure=true)
public @NotNull String substring(@NotNull
 @NotNull String str)

subSequence

@NotNull
public @NotNull CharSequence subSequence(@NotNull
 @NotNull CharSequence str)

cutOut

@NotNull
public @NotNull TextRange cutOut(@NotNull
 @NotNull TextRange subRange)

shiftRight

@NotNull
public @NotNull TextRange shiftRight(int delta)

shiftLeft

@NotNull
public @NotNull TextRange shiftLeft(int delta)

grown

@NotNull
public @NotNull TextRange grown(int lengthDelta)

from

@Contract(pure=true)
@NotNull
public static @NotNull TextRange from(int offset,
 int length)

create

@Contract(pure=true)
@NotNull
public static @NotNull TextRange create(int startOffset,
 int endOffset)

create

@NotNull
public static @NotNull TextRange create(@NotNull
 @NotNull Segment segment)

areSegmentsEqual

public static boolean areSegmentsEqual(@NotNull
 @NotNull Segment segment1,
 @NotNull
 @NotNull Segment segment2)

replace

@NotNull
public @NotNull String replace(@NotNull
 @NotNull String original,
 @NotNull
 @NotNull String replacement)

intersects

public boolean intersects(@NotNull
 @NotNull TextRange textRange)

intersects

public boolean intersects(@NotNull
 @NotNull Segment textRange)

intersects

public boolean intersects(int startOffset,
 int endOffset)

intersectsStrict

public boolean intersectsStrict(@NotNull
 @NotNull TextRange textRange)

intersectsStrict

public boolean intersectsStrict(int startOffset,
 int endOffset)

intersection

public TextRange intersection(@NotNull
 @NotNull TextRange range)

isEmpty

public boolean isEmpty()

union

@NotNull
public @NotNull TextRange union(@NotNull
 @NotNull TextRange textRange)

equalsToRange

public boolean equalsToRange(int startOffset,
 int endOffset)

allOf

@NotNull
public static @NotNull TextRange allOf(@NotNull
 @NotNull String s)

assertProperRange

public static void assertProperRange(@NotNull
 @NotNull Segment range)
                              throws AssertionError

Throws:

AssertionError

assertProperRange

public static void assertProperRange(@NotNull
 @NotNull Segment range,
 @NotNull
 @NotNull Object message)
                              throws AssertionError

Throws:

AssertionError

assertProperRange

public static void assertProperRange(int startOffset,
 int endOffset,
 @NotNull
 @NotNull Object message)

isProperRange

public static boolean isProperRange(int startOffset,
 int endOffset)