SegmentFinder.PrescribedSegmentFinder

Kotlin |Java

public static class SegmentFinder.PrescribedSegmentFinder
extends SegmentFinder

java.lang.Object
↳	android.text.SegmentFinder
	↳	android.text.SegmentFinder.PrescribedSegmentFinder

The default SegmentFinder implementation based on given segment ranges.

Summary

Inherited constants

From class android.text.SegmentFinder

int

DONE

Return value of previousStartBoundary(int), previousEndBoundary(int), nextStartBoundary(int), and nextEndBoundary(int) when there are no boundaries of the specified type in the specified direction.

Public constructors
`PrescribedSegmentFinder(int[] segments)` Create a SegmentFinder with segments stored in an array, where i-th segment's start is stored at segments[2 * i] and end is stored at segments[2 * i + 1] respectively.

Public methods
`int`	`nextEndBoundary(int offset)` Returns the character offset of the next text segment end boundary after the specified character offset, or `DONE` if there are none.
`int`	`nextStartBoundary(int offset)` Returns the character offset of the next text segment start boundary after the specified character offset, or `DONE` if there are none.
`int`	`previousEndBoundary(int offset)` Returns the character offset of the previous text segment end boundary before the specified character offset, or `DONE` if there are none.
`int`	`previousStartBoundary(int offset)` Returns the character offset of the previous text segment start boundary before the specified character offset, or `DONE` if there are none.

Inherited methods

From class


        
          android.text.SegmentFinder

`abstract int`	`nextEndBoundary(int offset)` Returns the character offset of the next text segment end boundary after the specified character offset, or `DONE` if there are none.
`abstract int`	`nextStartBoundary(int offset)` Returns the character offset of the next text segment start boundary after the specified character offset, or `DONE` if there are none.
`abstract int`	`previousEndBoundary(int offset)` Returns the character offset of the previous text segment end boundary before the specified character offset, or `DONE` if there are none.
`abstract int`	`previousStartBoundary(int offset)` Returns the character offset of the previous text segment start boundary before the specified character offset, or `DONE` if there are none.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

PrescribedSegmentFinder

Added in API level 34

public PrescribedSegmentFinder (int[] segments)

Create a SegmentFinder with segments stored in an array, where i-th segment's start is stored at segments[2 * i] and end is stored at segments[2 * i + 1] respectively.

It is required that segments do not overlap, and are already sorted by their start indices.

Parameters
`segments`	`int`: the array that stores the segment ranges.

Throws
`IllegalArgumentException`	if the given segments array's length is not even; the given segments are not sorted or there are segments overlap with others.

Public methods

nextEndBoundary

Added in API level 34

public int nextEndBoundary (int offset)

Returns the character offset of the next text segment end boundary after the specified character offset, or DONE if there are none.

Parameters
`offset`	`int`: Value is 0 or greater

Returns
`int`

nextStartBoundary

Added in API level 34

public int nextStartBoundary (int offset)

Returns the character offset of the next text segment start boundary after the specified character offset, or DONE if there are none.

Parameters
`offset`	`int`: Value is 0 or greater

Returns
`int`

previousEndBoundary

Added in API level 34

public int previousEndBoundary (int offset)

Returns the character offset of the previous text segment end boundary before the specified character offset, or DONE if there are none.

Parameters
`offset`	`int`: Value is 0 or greater

Returns
`int`

previousStartBoundary

Added in API level 34

public int previousStartBoundary (int offset)

Returns the character offset of the previous text segment start boundary before the specified character offset, or DONE if there are none.

Parameters
`offset`	`int`: Value is 0 or greater

Returns
`int`