PlainIntArray

java.lang.Object
- ohos.utils.PlainIntArray

所有已实现的接口:

Cloneable
```
public class PlainIntArray
extends Object
implements Cloneable
```
A basic collection class to store the data structures that use the primitive data type int as the key and value.
Values in this class are directly stored in arrays, without being wrapped into other types or automatically boxed. This simplifies the data storage structure and saves memory. All keys in this class are sorted in ascending order when they are stored, and the binary search algorithm is used to efficiently search for a specified key. In such data storage structures, keys and values can be iterated over based on indexes. This class implements the Cloneable interface.
Pay attention to the following when using the PlainIntArray class:
- This class is non-thread safe.
- Values are not stored in the same sequence as they are inserted.
从以下版本开始:

1

字段概要

字段
限定符和类型字段说明

static int INVALID_INDEX
Indicates an invalid index used by index-related operations.

字段
限定符和类型	字段	说明
`static int`	`INVALID_INDEX`	Indicates an invalid index used by index-related operations.

构造器概要

构造器
构造器	说明
`PlainIntArray()`	Default constructor used to create a `PlainIntArray` instance.
`PlainIntArray(int capacity)`	A constructor used to create a `PlainIntArray` instance with a custom initial capacity.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`void`	`append(int key, int value)`	Appends a key-value pair to `PlainIntArray`.
`void`	`clear()`	Clears all key-value pairs stored in the current `PlainIntArray` object.
`PlainIntArray`	`clone()`	Creates a clone of the current `PlainIntArray` object.
`boolean`	`contains(int key)`	Checks whether the current `PlainIntArray` object contains the specified `key`.
`Optional<Integer>`	`get(int key)`	Queries the value associated with a specified `key`.
`int`	`get(int key, int defaultValue)`	Queries the value associated with the specified `key` with the `defaultValue` parameter passed.
`int`	`indexOfKey(int key)`	Queries the index for a specified `key`.
`int`	`indexOfValue(int value)`	Queries the index for a specified `value`.
`boolean`	`isEmpty()`	Checks whether the current `PlainIntArray` object is empty.
`int`	`keyAt(int index)`	Queries the key at a specified index.
`int`	`locate(int key)`	Searches for the index of a specified key.
`void`	`put(int key, int value)`	Adds a key-value pair to `PlainIntArray`.
`Optional<Integer>`	`remove(int key)`	Removes the key-value pair based on a specified key.
`Optional<Integer>`	`removeAt(int index)`	Removes the key-value pair at a specified index.
`void`	`setValueAt(int index, int value)`	Updates the value at a specified index.
`int`	`size()`	Obtains the total number of values stored in the current `PlainIntArray`.
`String`	`toString()`	Obtains a string representation of the `PlainIntArray` object.
`int`	`valueAt(int index)`	Queries the value at a specified index.

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - INVALID_INDEX
```
public static final int INVALID_INDEX
```
    Indicates an invalid index used by index-related operations.
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - PlainIntArray
```
public PlainIntArray()
```
    Default constructor used to create a PlainIntArray instance.
  - PlainIntArray
```
public PlainIntArray(int capacity)
```
    A constructor used to create a PlainIntArray instance with a custom initial capacity.
    This constructor allows you to customize the initial capacity of the PlainIntArray object.
    
    参数:
    
    capacity - Indicates the initial capacity to customize for the object.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the specified capacity is less than or equal to 0.
- 方法详细资料
  - locate
```
public int locate(int key)
```
    Searches for the index of a specified key.
    The binary search algorithm is used for searching. If no result is found, a negative value is returned. However, you can invert this negative value to obtain the index where the key should be stored in the array.
    
    参数:
    
    key - Indicates the key to search for.
    
    返回:
    
    Returns the index of the key; returns a negative value if no result is found.
  - append
```
public void append(int key,
                   int value)
```
    Appends a key-value pair to PlainIntArray.
    If the key to be added is greater than any existing key in the array, this method is more efficient than the put(int,int) method. If the specified key is not the largest one in the array, the put(int,int) method is automatically called to add the key-value pair.
    
    参数:
    
    key - Indicates the key to be added.
    
    value - Indicates the value associated with the key.
  - clear
```
public void clear()
```
    Clears all key-value pairs stored in the current PlainIntArray object.
  - clone
```
public PlainIntArray clone()
```
    Creates a clone of the current PlainIntArray object.
    
    覆盖:
    
    clone 在类中 Object
    
    返回:
    
    Returns a clone of the PlainIntArray object.
    
    另请参阅:
    
    Cloneable
  - remove
```
public Optional<Integer> remove(int key)
```
    Removes the key-value pair based on a specified key.
    
    参数:
    
    key - Indicates the key to remove.
    
    返回:
    
    Returns an Optional object containing the removed value; returns an empty Optional object if key does not exist.
  - removeAt
```
public Optional<Integer> removeAt(int index)
```
    Removes the key-value pair at a specified index.
    
    参数:
    
    index - Indicates the index of the key-value pair to remove.
    
    返回:
    
    Returns an Optional object containing the removed value.
    
    抛出:
    
    IndexOutOfBoundsException - Throws this exception if the specified index is beyond the valid range.
  - get
```
public Optional<Integer> get(int key)
```
    Queries the value associated with a specified key.
    
    参数:
    
    key - Indicates the key of the value to query.
    
    返回:
    
    Returns an Optional object containing the obtained value; returns an empty Optional object if key does not exist.
  - get
```
public int get(int key,
               int defaultValue)
```
    Queries the value associated with the specified key with the defaultValue parameter passed.
    
    参数:
    
    key - Indicates the key of the value to query.
    
    defaultValue - Indicates the default value.
    
    返回:
    
    Returns the value of key; returns defaultValue if the key does not exist.
  - indexOfKey
```
public int indexOfKey(int key)
```
    Queries the index for a specified key.
    
    参数:
    
    key - Indicates the key to query.
    
    返回:
    
    Returns the index for the key; returns INVALID_INDEX if the queried key does not exist.
  - indexOfValue
```
public int indexOfValue(int value)
```
    Queries the index for a specified value.
    
    参数:
    
    value - Indicates the value to query.
    
    返回:
    
    Returns the index for the first matched value if more than one value is found; returns INVALID_INDEX if the queried value does not exist.
  - keyAt
```
public int keyAt(int index)
```
    Queries the key at a specified index.
    
    参数:
    
    index - Indicates the index to query.
    
    返回:
    
    Returns the key of the specified index.
    
    抛出:
    
    IndexOutOfBoundsException - Throws this exception if the specified index is beyond the valid range.
  - valueAt
```
public int valueAt(int index)
```
    Queries the value at a specified index.
    
    参数:
    
    index - Indicates the index to query.
    
    返回:
    
    Returns the value of the specified index.
    
    抛出:
    
    IndexOutOfBoundsException - Throws this exception if the specified index is beyond the valid range.
  - put
```
public void put(int key,
                int value)
```
    Adds a key-value pair to PlainIntArray.
    If the specified key already exists, its value will be replaced by value.
    
    参数:
    
    key - Indicates the key to be added.
    
    value - Indicates the value associated with the key.
  - setValueAt
```
public void setValueAt(int index,
                       int value)
```
    Updates the value at a specified index.
    
    参数:
    
    index - Indicates the index of the value to update.
    
    value - Indicates the new value.
    
    抛出:
    
    IndexOutOfBoundsException - Throws this exception if the specified index is beyond the valid range.
  - size
```
public int size()
```
    Obtains the total number of values stored in the current PlainIntArray.
    
    返回:
    
    Returns the total number of stored values.
  - isEmpty
```
public boolean isEmpty()
```
    Checks whether the current PlainIntArray object is empty.
    
    返回:
    
    Returns true if no value is contained; returns false otherwise.
  - contains
```
public boolean contains(int key)
```
    Checks whether the current PlainIntArray object contains the specified key.
    
    参数:
    
    key - Indicates the key to check.
    
    返回:
    
    Returns true if the specified key exists; returns false otherwise.
  - toString
```
public String toString()
```
    Obtains a string representation of the PlainIntArray object.
    The returned string representation is JSON-compliant.
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    Returns the JSON-based string representation of PlainIntArray.

类 PlainIntArray

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

INVALID_INDEX

构造器详细资料

PlainIntArray

PlainIntArray

方法详细资料

locate

append

clear

clone

remove

removeAt

get

get

indexOfKey

indexOfValue

keyAt

valueAt

put

setValueAt

size

isEmpty

contains

toString