AsyncDistributedList (Atomix API Reference (3.0.0-rc4))

All Superinterfaces:

AsyncDistributedCollection<E>, AsyncIterable<E>, AsyncPrimitive, DistributedPrimitive
```
public interface AsyncDistributedList<E>
extends AsyncDistributedCollection<E>
```
Asynchronous distributed list.

Field Summary
- Fields inherited from interface io.atomix.primitive.DistributedPrimitive
  DEFAULT_OPERATION_TIMEOUT_MILLIS

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`CompletableFuture<Void>`	`add(int index, E element)` Inserts the specified element at the specified position in this list (optional operation).
`CompletableFuture<Boolean>`	`addAll(int index, Collection<? extends E> c)` Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
`CompletableFuture<E>`	`get(int index)` Returns the element at the specified position in this list.
`CompletableFuture<Integer>`	`indexOf(Object o)` Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
`CompletableFuture<Integer>`	`lastIndexOf(Object o)` Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
`CompletableFuture<E>`	`remove(int index)` Removes the element at the specified position in this list (optional operation).
`CompletableFuture<E>`	`set(int index, E element)` Replaces the element at the specified position in this list with the specified element (optional operation).
`default DistributedList<E>`	`sync()` Returns a synchronous wrapper around the asynchronous primitive.
`DistributedList<E>`	`sync(Duration operationTimeout)` Returns a synchronous wrapper around the asynchronous primitive.

Methods inherited from interface io.atomix.core.collection.AsyncDistributedCollection
add, addAll, addListener, addListener, clear, contains, containsAll, isEmpty, remove, removeAll, removeListener, retainAll, size

Methods inherited from interface io.atomix.primitive.AsyncPrimitive
close, delete

Methods inherited from interface io.atomix.primitive.DistributedPrimitive
addStateChangeListener, name, protocol, removeStateChangeListener, type

Methods inherited from interface io.atomix.core.iterator.AsyncIterable
iterator, stream

- Method Detail
  - addAll
```
CompletableFuture<Boolean> addAll(int index,
                                  Collection<? extends E> c)
```
    Inserts all of the elements in the specified collection into this list at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
    
    Parameters:
    
    index - index at which to insert the first element from the specified collection
    
    c - collection containing elements to be added to this list
    
    Returns:
    
    true if this list changed as a result of the call
    
    Throws:
    
    UnsupportedOperationException - if the addAll operation is not supported by this list
    
    ClassCastException - if the class of an element of the specified collection prevents it from being added to this list
    
    NullPointerException - if the specified collection contains one or more null elements and this list does not permit null elements, or if the specified collection is null
    
    IllegalArgumentException - if some property of an element of the specified collection prevents it from being added to this list
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())
  - get
```
CompletableFuture<E> get(int index)
```
    Returns the element at the specified position in this list.
    
    Parameters:
    
    index - index of the element to return
    
    Returns:
    
    the element at the specified position in this list
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
  - set
```
CompletableFuture<E> set(int index,
                         E element)
```
    Replaces the element at the specified position in this list with the specified element (optional operation).
    
    Parameters:
    
    index - index of the element to replace
    
    element - element to be stored at the specified position
    
    Returns:
    
    the element previously at the specified position
    
    Throws:
    
    UnsupportedOperationException - if the set operation is not supported by this list
    
    ClassCastException - if the class of the specified element prevents it from being added to this list
    
    NullPointerException - if the specified element is null and this list does not permit null elements
    
    IllegalArgumentException - if some property of the specified element prevents it from being added to this list
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
  - add
```
CompletableFuture<Void> add(int index,
                            E element)
```
    Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
    
    Parameters:
    
    index - index at which the specified element is to be inserted
    
    element - element to be inserted
    
    Throws:
    
    UnsupportedOperationException - if the add operation is not supported by this list
    
    ClassCastException - if the class of the specified element prevents it from being added to this list
    
    NullPointerException - if the specified element is null and this list does not permit null elements
    
    IllegalArgumentException - if some property of the specified element prevents it from being added to this list
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())
  - remove
```
CompletableFuture<E> remove(int index)
```
    Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.
    
    Parameters:
    
    index - the index of the element to be removed
    
    Returns:
    
    the element previously at the specified position
    
    Throws:
    
    UnsupportedOperationException - if the remove operation is not supported by this list
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
  - indexOf
```
CompletableFuture<Integer> indexOf(Object o)
```
    Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
    
    Parameters:
    
    o - element to search for
    
    Returns:
    
    the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element
    
    Throws:
    
    ClassCastException - if the type of the specified element is incompatible with this list (optional)
    
    NullPointerException - if the specified element is null and this list does not permit null elements (optional)
  - lastIndexOf
```
CompletableFuture<Integer> lastIndexOf(Object o)
```
    Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
    
    Parameters:
    
    o - element to search for
    
    Returns:
    
    the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element
    
    Throws:
    
    ClassCastException - if the type of the specified element is incompatible with this list (optional)
    
    NullPointerException - if the specified element is null and this list does not permit null elements (optional)
  - sync
```
default DistributedList<E> sync()
```
    Description copied from interface: AsyncPrimitive
    
    Returns a synchronous wrapper around the asynchronous primitive.
    
    Specified by:
    
    sync in interface AsyncDistributedCollection<E>
    
    Specified by:
    
    sync in interface AsyncPrimitive
    
    Returns:
    
    the synchronous primitive
  - sync
```
DistributedList<E> sync(Duration operationTimeout)
```
    Description copied from interface: AsyncPrimitive
    
    Returns a synchronous wrapper around the asynchronous primitive.
    
    Specified by:
    
    sync in interface AsyncDistributedCollection<E>
    
    Specified by:
    
    sync in interface AsyncPrimitive
    
    Parameters:
    
    operationTimeout - the synchronous operation timeout
    
    Returns:
    
    the synchronous primitive

Interface AsyncDistributedList<E>

Field Summary

Fields inherited from interface io.atomix.primitive.DistributedPrimitive

Method Summary

Methods inherited from interface io.atomix.core.collection.AsyncDistributedCollection

Methods inherited from interface io.atomix.primitive.AsyncPrimitive

Methods inherited from interface io.atomix.primitive.DistributedPrimitive

Methods inherited from interface io.atomix.core.iterator.AsyncIterable

Method Detail

addAll

get

set

add

remove

indexOf

lastIndexOf

sync

sync