Added in API level 29

Position

open class Position
kotlin.Any
   ↳ android.icu.text.Transliterator.Position

Position structure for incremental transliteration. This data structure defines two substrings of the text being transliterated. The first region, [contextStart, contextLimit), defines what characters the transliterator will read as context. The second region, [start, limit), defines what characters will actually be transliterated. The second region should be a subset of the first.

After a transliteration operation, some of the indices in this structure will be modified. See the field descriptions for details.

contextStart <= start <= limit <= contextLimit

Note: All index values in this structure must be at code point boundaries. That is, none of them may occur between two code units of a surrogate pair. If any index does split a surrogate pair, results are unspecified.

Summary

Public constructors

Constructs a Position object with start, limit, contextStart, and contextLimit all equal to zero.
Position(contextStart: Int, contextLimit: Int, start: Int)

Constructs a Position object with the given start, contextStart, and contextLimit.
Position(contextStart: Int, contextLimit: Int, start: Int, limit: Int)

Constructs a Position object with the given start, limit, contextStart, and contextLimit.

Constructs a Position object that is a copy of another.
Public methods
open Boolean
equals(other: Any?)

Returns true if this Position is equal to the given object.
open Int

Returns a hash code value for the object.
open Unit

Copies the indices of this position from another.
open String

Returns a string representation of this Position.
Unit
validate(length: Int)

Check all bounds.
Properties
Int

Ending index, exclusive, of the context to be considered for a transliteration operation.
Int

Beginning index, inclusive, of the context to be considered for a transliteration operation.
Int

Ending index, exclusive, of the text to be transliteratd.
Int

Beginning index, inclusive, of the text to be transliteratd.

Public constructors

Position

Added in API level 29
Position()

Constructs a Position object with start, limit, contextStart, and contextLimit all equal to zero.

Position

Added in API level 29
Position(
    contextStart: Int, 
    contextLimit: Int, 
    start: Int)

Constructs a Position object with the given start, contextStart, and contextLimit. The limit is set to the contextLimit.

Position

Added in API level 29
Position(
    contextStart: Int, 
    contextLimit: Int, 
    start: Int, 
    limit: Int)

Constructs a Position object with the given start, limit, contextStart, and contextLimit.

Position

Added in API level 29
Position(pos: Transliterator.Position!)

Constructs a Position object that is a copy of another.

Public methods

equals

Added in API level 29
open fun equals(other: Any?): Boolean

Returns true if this Position is equal to the given object.

Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

hashCode

Added in API level 29
open fun hashCode(): Int

Returns a hash code value for the 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.
Return
Int a hash code value for this object.

set

Added in API level 29
open fun set(pos: Transliterator.Position!): Unit

Copies the indices of this position from another.

toString

Added in API level 29
open fun toString(): String

Returns a string representation of this Position.

Return
String a string representation of the object.

validate

Added in API level 29
fun validate(length: Int): Unit

Check all bounds. If they are invalid, throw an exception.

Parameters
length Int: the length of the string this object applies to
Exceptions
java.lang.IllegalArgumentException if any indices are out of bounds

Properties

contextLimit

Added in API level 29
var contextLimit: Int

Ending index, exclusive, of the context to be considered for a transliteration operation. The transliterator will ignore anything at or after this index. INPUT/OUTPUT parameter: This parameter is updated to reflect changes in the length of the text, but points to the same logical position in the text.

contextStart

Added in API level 29
var contextStart: Int

Beginning index, inclusive, of the context to be considered for a transliteration operation. The transliterator will ignore anything before this index. INPUT/OUTPUT parameter: This parameter is updated by a transliteration operation to reflect the maximum amount of antecontext needed by a transliterator.

limit

Added in API level 29
var limit: Int

Ending index, exclusive, of the text to be transliteratd. INPUT/OUTPUT parameter: This parameter is updated to reflect changes in the length of the text, but points to the same logical position in the text.

start

Added in API level 29
var start: Int

Beginning index, inclusive, of the text to be transliteratd. INPUT/OUTPUT parameter: This parameter is advanced past characters that have already been transliterated by a transliteration operation.