BasicArray (Debezium Core 1.4.0.Final API)

java.lang.Object
- io.debezium.document.BasicArray

All Implemented Interfaces:

Array, Comparable<Array>, Iterable<Array.Entry>
```
@NotThreadSafe
final class BasicArray
extends Object
implements Array
```
Package-level implementation of Array.

Author:

Randall Hauch

Nested Class Summary
- Nested classes/interfaces inherited from interface io.debezium.document.Array
  Array.Entry

Field Summary

Fields
Modifier and Type Field and Description

private static BiFunction<Integer,Value,Array.Entry> CONVERT_PAIR_TO_ENTRY

private List<Value> values

Fields
Modifier and Type	Field and Description
`private static BiFunction<Integer,Value,Array.Entry>`	`CONVERT_PAIR_TO_ENTRY`
`private List<Value>`	`values`

Constructor Summary

Constructors
Constructor and Description

BasicArray()

BasicArray(List<Value> values)

BasicArray(Value[] values)

Constructors
Constructor and Description
`BasicArray()`
`BasicArray(List<Value> values)`
`BasicArray(Value[] values)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Array`	`add(Value value)` Adds the value to the end of this array.
`Array`	`clone()` Obtain a complete copy of this array.
`int`	`compareTo(Array that)`
`boolean`	`equals(Object obj)`
`Array`	`expand(int desiredSize, Value value)` If the current size of the array is smaller than the given size, expand it and use the supplied value for all new entries.
`Value`	`get(int index)` Gets the value in this array at the given index.
`boolean`	`has(int index)` Determine if this contains an entry at the given index.
`int`	`hashCode()`
`Array`	`increment(int index, Value increment)` Increment the numeric value at the given location by the designated amount.
`protected int`	`indexFrom(CharSequence name)`
`boolean`	`isEmpty()` Return whether this document contains no fields and is therefore empty.
`protected boolean`	`isValidIndex(int index)`
`Iterator<Array.Entry>`	`iterator()`
`Value`	`remove(int index)` Remove the specified entry from this array
`Array`	`removeAll()` Remove all entries from this array.
`Array`	`setValue(int index, Value value)` Set the value for the field with the given name to be a value.
`int`	`size()` Return the number of name-value fields in this object.
`String`	`toString()`
`Iterable<Value>`	`values()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.debezium.document.Array
add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, addAll, addAll, addAll, addAll, addNull, create, create, create, create, create, create, createWithNulls, expand, expand, expand, expand, expand, expand, expand, get, increment, increment, increment, increment, isNull, isNullOrMissing, putAll, setArray, setArray, setArray, setBinary, setBoolean, setDocument, setDocument, setNull, setNumber, setNumber, setNumber, setNumber, setNumber, setNumber, setString, streamEntries, streamValues, transform

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - CONVERT_PAIR_TO_ENTRY
```
private static final BiFunction<Integer,Value,Array.Entry> CONVERT_PAIR_TO_ENTRY
```
  - values
```
private final List<Value> values
```
- Constructor Detail
  - BasicArray
```
BasicArray()
```
  - BasicArray
```
BasicArray(List<Value> values)
```
  - BasicArray
```
BasicArray(Value[] values)
```
- Method Detail
  - indexFrom
```
protected final int indexFrom(CharSequence name)
```
  - isValidIndex
```
protected final boolean isValidIndex(int index)
```
  - size
```
public int size()
```
    Description copied from interface: Array
    
    Return the number of name-value fields in this object.
    
    Specified by:
    
    size in interface Array
    
    Returns:
    
    the number of name-value fields; never negative
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Array
    
    Return whether this document contains no fields and is therefore empty.
    
    Specified by:
    
    isEmpty in interface Array
    
    Returns:
    
    true if there are no fields in this document, or false if there is at least one.
  - compareTo
```
public int compareTo(Array that)
```
    Specified by:
    
    compareTo in interface Comparable<Array>
  - iterator
```
public Iterator<Array.Entry> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Array.Entry>
  - remove
```
public Value remove(int index)
```
    Description copied from interface: Array
    
    Remove the specified entry from this array
    
    Specified by:
    
    remove in interface Array
    
    Parameters:
    
    index - the index
    
    Returns:
    
    the value in the removed entry, or null if there is no such entry
  - removeAll
```
public Array removeAll()
```
    Description copied from interface: Array
    
    Remove all entries from this array.
    
    Specified by:
    
    removeAll in interface Array
    
    Returns:
    
    this array to allow for chaining methods
  - has
```
public boolean has(int index)
```
    Description copied from interface: Array
    
    Determine if this contains an entry at the given index.
    
    Specified by:
    
    has in interface Array
    
    Parameters:
    
    index - the index
    
    Returns:
    
    true if the entry exists, or false otherwise
  - get
```
public Value get(int index)
```
    Description copied from interface: Array
    
    Gets the value in this array at the given index.
    
    Specified by:
    
    get in interface Array
    
    Parameters:
    
    index - the index
    
    Returns:
    
    The field value, if found, or null otherwise
  - setValue
```
public Array setValue(int index,
                      Value value)
```
    Description copied from interface: Array
    
    Set the value for the field with the given name to be a value.
    
    Specified by:
    
    setValue in interface Array
    
    Parameters:
    
    index - the index of the field; must be greater than or equal to 0 and less than or equal to size
    
    value - the new value
    
    Returns:
    
    this array to allow for chaining methods
  - expand
```
public Array expand(int desiredSize,
                    Value value)
```
    Description copied from interface: Array
    
    If the current size of the array is smaller than the given size, expand it and use the supplied value for all new entries. This method does nothing if the current size is larger than the supplied desiredSize.
    
    Specified by:
    
    expand in interface Array
    
    Parameters:
    
    desiredSize - the desired size of the array; may be negative
    
    value - the new value for any new entries
    
    Returns:
    
    this array to allow for chaining methods
  - increment
```
public Array increment(int index,
                       Value increment)
```
    Description copied from interface: Array
    
    Increment the numeric value at the given location by the designated amount.
    
    Specified by:
    
    increment in interface Array
    
    Parameters:
    
    index - the index of the field; must be greater than or equal to 0 and less than or equal to size
    
    increment - the amount to increment the existing value; may be negative to decrement
    
    Returns:
    
    this array to allow for chaining methods
  - add
```
public Array add(Value value)
```
    Description copied from interface: Array
    
    Adds the value to the end of this array.
    
    Specified by:
    
    add in interface Array
    
    Parameters:
    
    value - the value; may not be null
    
    Returns:
    
    this array to allow for chaining methods
  - values
```
public Iterable<Value> values()
```
    Specified by:
    
    values in interface Array
  - clone
```
public Array clone()
```
    Description copied from interface: Array
    
    Obtain a complete copy of this array.
    
    Specified by:
    
    clone in interface Array
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    the clone of this array; never null
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BasicArray

Nested Class Summary

Nested classes/interfaces inherited from interface io.debezium.document.Array

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.debezium.document.Array

Methods inherited from interface java.lang.Iterable

Field Detail

CONVERT_PAIR_TO_ENTRY

values

Constructor Detail

BasicArray

BasicArray

BasicArray

Method Detail

indexFrom

isValidIndex

size

isEmpty

compareTo

iterator

remove

removeAll

has

get

setValue

expand

increment

add

values

clone

hashCode

equals

toString