flexmark-all 0.64.8 · com.vladsch.flexmark.util.sequence.Range

Modifier and Type	Field and Description
public static final Range	EMPTY
private final int	end
public static final Range	NULL
private final int	start

Access	Constructor and Description
protected	Range(int start start, int end end) Create range
protected	Range(@NotNull Range other)

Method Summary

Modifier and Type	Method and Description
public @NotNull BasedSequence	basedSafeSubSequence(@NotNull CharSequence charSequence)
public @NotNull BasedSequence	basedSubSequence(@NotNull CharSequence charSequence)
public @NotNull CharSequence	charSubSequence(@NotNull CharSequence charSequence)
public int	compare(@NotNull Range other)
public int	component1()
public int	component2()
public boolean	contains(@NotNull Range other)
public boolean	contains(int index)
public boolean	contains(int start, int end)
public boolean	doesContain(@NotNull Range other)
public boolean	doesContain(int index)
public boolean	doesContain(int start, int end)
public boolean	doesNotOverlap(@NotNull Range other)
public boolean	doesNotOverlapNorAdjacent(@NotNull Range other)
public boolean	doesNotOverlapOrAdjacent(@NotNull Range other)
public boolean	doesOverlap(@NotNull Range other)
public boolean	doesOverlapOrAdjacent(@NotNull Range other)
public boolean	doesProperlyContain(@NotNull Range other)
public static @NotNull Range	emptyOf(int position)
public Range	endMinus(int delta)
public Range	endPlus(int delta)
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public @NotNull Range	exclude(@NotNull Range other)
public @NotNull Range	expandToInclude(@NotNull Range other)
public @NotNull Range	expandToInclude(int start, int end)
public int	getEnd()
public int	getEndOffset()
public int	getSpan()
public int	getStart()
public int	getStartOffset()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public @NotNull Range	include(@NotNull Range other)
public @NotNull Range	include(int pos)
public @NotNull Range	include(int start, int end)
public @NotNull Range	intersect(@NotNull Range other)
public boolean	isAdjacent(int index)
public boolean	isAdjacent(@NotNull Range other)
public boolean	isAdjacentAfter(int index)
public boolean	isAdjacentAfter(@NotNull Range other)
public boolean	isAdjacentBefore(int index)
public boolean	isAdjacentBefore(@NotNull Range other)
public boolean	isContainedBy(@NotNull Range other)
public boolean	isContainedBy(int start, int end)
public boolean	isEmpty()
public boolean	isEnd(int index)
public boolean	isEqual(@NotNull Range other)
public boolean	isLast(int index)
public boolean	isNotEmpty()
public boolean	isNotNull()
public boolean	isNull()
public boolean	isProperlyContainedBy(@NotNull Range other)
public boolean	isProperlyContainedBy(int start, int end)
public boolean	isStart(int index)
public boolean	isValidIndex(int index)
public boolean	leadBy(int index)
public boolean	leads(int index)
public static @NotNull Range	of(int start, int end)
public static @NotNull Range	ofLength(int start, int length)
public boolean	overlaps(@NotNull Range other)
public boolean	overlapsOrAdjacent(@NotNull Range other)
public boolean	properlyContains(@NotNull Range other)
public @NotNull RichSequence	richSafeSubSequence(@NotNull CharSequence charSequence)
public @NotNull RichSequence	richSubSequence(@NotNull CharSequence charSequence)
public @NotNull CharSequence	safeSubSequence(@NotNull CharSequence charSequence)
public Range	shiftLeft(int delta)
public Range	shiftRight(int delta)
public Range	startMinus(int delta)
public Range	startPlus(int delta)
public @NotNull BasedSequence	Returns: resulting based subsequence subSequence(@NotNull CharSequence char sequence from which to extract the range charSequence) Deprecated use `basedSubSequence(CharSequence)` instead Return a based subsequence of sequence given by this range
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public boolean	trailedBy(int index)
public boolean	trails(int index)
public Range	withEnd(int end)
public Range	withRange(int start, int end)
public Range	withStart(int start)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

EMPTY	back to summary
public static final Range EMPTY

end	back to summary
private final int end

NULL	back to summary
public static final Range NULL

start	back to summary
private final int start

Range	back to summary
protected Range(int start, int end) Create range Parameters start:int start end:int end

Range	back to summary
protected Range(@NotNull Range other)

Method Detail

basedSafeSubSequence	back to summary
public @NotNull BasedSequence basedSafeSubSequence(@NotNull CharSequence charSequence) Annotations @NotNull

basedSubSequence	back to summary
public @NotNull BasedSequence basedSubSequence(@NotNull CharSequence charSequence) Annotations @NotNull

charSubSequence	back to summary
public @NotNull CharSequence charSubSequence(@NotNull CharSequence charSequence) Annotations @NotNull

compare	back to summary
public int compare(@NotNull Range other)

component1	back to summary
public int component1()

component2	back to summary
public int component2()

contains	back to summary
public boolean contains(@NotNull Range other)

contains	back to summary
public boolean contains(int index)

contains	back to summary
public boolean contains(int start, int end)

doesContain	back to summary
public boolean doesContain(@NotNull Range other)

doesContain	back to summary
public boolean doesContain(int index)

doesContain	back to summary
public boolean doesContain(int start, int end)

doesNotOverlap	back to summary
public boolean doesNotOverlap(@NotNull Range other)

doesNotOverlapNorAdjacent	back to summary
public boolean doesNotOverlapNorAdjacent(@NotNull Range other)

doesNotOverlapOrAdjacent	back to summary
public boolean doesNotOverlapOrAdjacent(@NotNull Range other)

doesOverlap	back to summary
public boolean doesOverlap(@NotNull Range other)

doesOverlapOrAdjacent	back to summary
public boolean doesOverlapOrAdjacent(@NotNull Range other)

doesProperlyContain	back to summary
public boolean doesProperlyContain(@NotNull Range other)

emptyOf	back to summary
public static @NotNull Range emptyOf(int position) Annotations @NotNull

endMinus	back to summary
public Range endMinus(int delta)

endPlus	back to summary
public Range endPlus(int delta)

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

exclude	back to summary
public @NotNull Range exclude(@NotNull Range other) Annotations @NotNull

expandToInclude	back to summary
public @NotNull Range expandToInclude(@NotNull Range other) Annotations @NotNull

expandToInclude	back to summary
public @NotNull Range expandToInclude(int start, int end) Annotations @NotNull

getEnd	back to summary
public int getEnd()

getEndOffset	back to summary
public int getEndOffset()

getSpan	back to summary
public int getSpan()

getStart	back to summary
public int getStart()

getStartOffset	back to summary
public int getStartOffset()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

include	back to summary
public @NotNull Range include(@NotNull Range other) Annotations @NotNull

include	back to summary
public @NotNull Range include(int pos) Annotations @NotNull

include	back to summary
public @NotNull Range include(int start, int end) Annotations @NotNull

intersect	back to summary
public @NotNull Range intersect(@NotNull Range other) Annotations @NotNull

isAdjacent	back to summary
public boolean isAdjacent(int index)

isAdjacent	back to summary
public boolean isAdjacent(@NotNull Range other)

isAdjacentAfter	back to summary
public boolean isAdjacentAfter(int index)

isAdjacentAfter	back to summary
public boolean isAdjacentAfter(@NotNull Range other)

isAdjacentBefore	back to summary
public boolean isAdjacentBefore(int index)

isAdjacentBefore	back to summary
public boolean isAdjacentBefore(@NotNull Range other)

isContainedBy	back to summary
public boolean isContainedBy(@NotNull Range other)

isContainedBy	back to summary
public boolean isContainedBy(int start, int end)

isEmpty	back to summary
public boolean isEmpty()

isEnd	back to summary
public boolean isEnd(int index)

isEqual	back to summary
public boolean isEqual(@NotNull Range other)

isLast	back to summary
public boolean isLast(int index)

isNotEmpty	back to summary
public boolean isNotEmpty()

isNotNull	back to summary
public boolean isNotNull()

isNull	back to summary
public boolean isNull()

isProperlyContainedBy	back to summary
public boolean isProperlyContainedBy(@NotNull Range other)

isProperlyContainedBy	back to summary
public boolean isProperlyContainedBy(int start, int end)

isStart	back to summary
public boolean isStart(int index)

isValidIndex	back to summary
public boolean isValidIndex(int index)

leadBy	back to summary
public boolean leadBy(int index)

leads	back to summary
public boolean leads(int index)

of	back to summary
public static @NotNull Range of(int start, int end) Annotations @NotNull

ofLength	back to summary
public static @NotNull Range ofLength(int start, int length) Annotations @NotNull

overlaps	back to summary
public boolean overlaps(@NotNull Range other)

overlapsOrAdjacent	back to summary
public boolean overlapsOrAdjacent(@NotNull Range other)

properlyContains	back to summary
public boolean properlyContains(@NotNull Range other)

richSafeSubSequence	back to summary
public @NotNull RichSequence richSafeSubSequence(@NotNull CharSequence charSequence) Annotations @NotNull

richSubSequence	back to summary
public @NotNull RichSequence richSubSequence(@NotNull CharSequence charSequence) Annotations @NotNull

safeSubSequence	back to summary
public @NotNull CharSequence safeSubSequence(@NotNull CharSequence charSequence) Annotations @NotNull

shiftLeft	back to summary
public Range shiftLeft(int delta)

shiftRight	back to summary
public Range shiftRight(int delta)

startMinus	back to summary
public Range startMinus(int delta)

startPlus	back to summary
public Range startPlus(int delta)

subSequence back to summary

public @NotNull BasedSequence subSequence(@NotNull CharSequence charSequence)

Deprecated

use basedSubSequence(CharSequence) instead

Return a based subsequence of sequence given by this range

Parameters

charSequence:@NotNull CharSequence: char sequence from which to extract the range

Returns:@NotNull BasedSequence

resulting based subsequence

Annotations

@NotNull
@Deprecated

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

trailedBy	back to summary
public boolean trailedBy(int index)

trails	back to summary
public boolean trails(int index)

withEnd	back to summary
public Range withEnd(int end)

withRange	back to summary
public Range withRange(int start, int end)

withStart	back to summary
public Range withStart(int start)

public Class Range

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail