# SegmentFinder.PrescribedSegmentFinder

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Inherited Constants](https://developer.android.com/reference/android/text/SegmentFinder.PrescribedSegmentFinder#inhconstants)\|[Ctors](https://developer.android.com/reference/android/text/SegmentFinder.PrescribedSegmentFinder#pubctors)\|[Methods](https://developer.android.com/reference/android/text/SegmentFinder.PrescribedSegmentFinder#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/text/SegmentFinder.PrescribedSegmentFinder#inhmethods)  

# SegmentFinder.PrescribedSegmentFinder

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/text/SegmentFinder.PrescribedSegmentFinder "View this page in Kotlin")\|Java

`
public
static


class
SegmentFinder.PrescribedSegmentFinder
`  
`


``

extends `[SegmentFinder](https://developer.android.com/reference/android/text/SegmentFinder)`


``


`

|---|---|----------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||
| ↳ | [android.text.SegmentFinder](https://developer.android.com/reference/android/text/SegmentFinder) ||
|   | ↳ | android.text.SegmentFinder.PrescribedSegmentFinder |

<br />

*** ** * ** ***

The default[SegmentFinder](https://developer.android.com/reference/android/text/SegmentFinder)implementation based on given segment ranges.

## Summary

|                                                                                                                                                                                                                                                                                                                                            ### Inherited constants                                                                                                                                                                                                                                                                                                                                             |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From class[android.text.SegmentFinder](https://developer.android.com/reference/android/text/SegmentFinder) |-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [DONE](https://developer.android.com/reference/android/text/SegmentFinder#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](https://developer.android.com/reference/android/text/SegmentFinder.PrescribedSegmentFinder#PrescribedSegmentFinder(int[]))`(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](https://developer.android.com/reference/android/text/SegmentFinder.PrescribedSegmentFinder#nextEndBoundary(int))`(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](https://developer.android.com/reference/android/text/SegmentFinder.PrescribedSegmentFinder#nextStartBoundary(int))`(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](https://developer.android.com/reference/android/text/SegmentFinder.PrescribedSegmentFinder#previousEndBoundary(int))`(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](https://developer.android.com/reference/android/text/SegmentFinder.PrescribedSegmentFinder#previousStartBoundary(int))`(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](https://developer.android.com/reference/android/text/SegmentFinder)` ` |-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int` | ` `[nextEndBoundary](https://developer.android.com/reference/android/text/SegmentFinder#nextEndBoundary(int))`(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](https://developer.android.com/reference/android/text/SegmentFinder#nextStartBoundary(int))`(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](https://developer.android.com/reference/android/text/SegmentFinder#previousEndBoundary(int))`(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](https://developer.android.com/reference/android/text/SegmentFinder#previousStartBoundary(int))`(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](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(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](https://developer.android.com/reference/java/lang/Object#wait(long))`(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](https://developer.android.com/reference/java/lang/Object#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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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.

<br />

<br />

|                             Parameters                              ||
|------------|---------------------------------------------------------|
| `segments` | `int`: the array that stores the segment ranges. <br /> |

|                                                                                                                 Throws                                                                                                                 ||
|--------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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.

<br />

|                  Parameters                   ||
|----------|-------------------------------------|
| `offset` | `int`: Value is 0 or greater <br /> |

|    Returns    ||
|-------|--------|
| `int` | <br /> |

### nextStartBoundary

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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.

<br />

|                  Parameters                   ||
|----------|-------------------------------------|
| `offset` | `int`: Value is 0 or greater <br /> |

|    Returns    ||
|-------|--------|
| `int` | <br /> |

### previousEndBoundary

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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.

<br />

|                  Parameters                   ||
|----------|-------------------------------------|
| `offset` | `int`: Value is 0 or greater <br /> |

|    Returns    ||
|-------|--------|
| `int` | <br /> |

### previousStartBoundary

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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.

<br />

|                  Parameters                   ||
|----------|-------------------------------------|
| `offset` | `int`: Value is 0 or greater <br /> |

|    Returns    ||
|-------|--------|
| `int` | <br /> |