ListIndexProxy (Exonum Java Binding: Core 0.1.1 API)

java.lang.Object
- com.exonum.binding.proxy.AbstractNativeProxy
- - com.exonum.binding.storage.indices.ListIndexProxy<E>

Type Parameters:

E - the type of elements in this list

All Implemented Interfaces:

ListIndex<E>, java.lang.Iterable<E>
```
public final class ListIndexProxy<E>
extends AbstractNativeProxy
implements ListIndex<E>
```
A list index proxy is a contiguous list of elements. Elements may be added to or removed from the end of the list only.
This list implementation does not permit null elements.
The "destructive" methods of the list, i.e., those that change its contents, are specified to throw UnsupportedOperationException if this list has been created with a read-only database view.
All method arguments are non-null by default.
This class is not thread-safe and and its instances shall not be shared between threads.
When the view goes out of scope, this list is destroyed. Subsequent use of the closed list is prohibited and will result in IllegalStateException.

See Also:

View

Field Summary
- Fields inherited from class com.exonum.binding.proxy.AbstractNativeProxy
  nativeHandle

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(T e)` Adds a new element to the end of the list.
`void`	`addAll(java.util.Collection<? extends T> elements)` Adds all elements from the specified collection to this list.
`void`	`clear()` Clears the list.
`T`	`get(long index)` Returns the element at the given index.
`T`	`getLast()` Returns the last element of the list.
`java.lang.String`	`getName()` Returns the name of this index.
`java.lang.String`	`getName()` Returns the name of this index.
`boolean`	`isEmpty()` Returns true if the list is empty, false — otherwise.
`java.util.Iterator<T>`	`iterator()` Returns an iterator over the elements of the list.
`static <E> ListIndexProxy<E>`	`newInGroupUnsafe(java.lang.String groupName, byte[] listId, View view, com.exonum.binding.storage.serialization.Serializer<E> serializer)` Creates a new list in a collection group with the given name.
`static <E> ListIndexProxy<E>`	`newInstance(java.lang.String name, View view, com.exonum.binding.storage.serialization.Serializer<E> serializer)` Creates a new ListIndexProxy.
`E`	`removeLast()` Removes the last element of the list and returns it.
`void`	`set(long index, T e)` Replaces the element at the given index of the list with the specified element.
`long`	`size()` Returns the number of elements in the list.
`java.lang.String`	`toString()`
`void`	`truncate(long newSize)` Truncates the list, reducing its size to `newSize`.

Methods inherited from class com.exonum.binding.proxy.AbstractNativeProxy
getNativeHandle, isValidHandle

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

Methods inherited from interface com.exonum.binding.storage.indices.ListIndex
add, addAll, clear, get, getLast, isEmpty, iterator, set, size

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

- Method Detail
  - newInstance
```
public static <E> ListIndexProxy<E> newInstance(java.lang.String name,
                                                View view,
                                                com.exonum.binding.storage.serialization.Serializer<E> serializer)
```
    Creates a new ListIndexProxy.
    
    Type Parameters:
    
    E - the type of elements in this list
    
    Parameters:
    
    name - a unique alphanumeric non-empty identifier of this list in the underlying storage: [a-zA-Z0-9_]
    
    view - a database view. Must be valid. If a view is read-only, "destructive" operations are not permitted.
    
    serializer - a serializer of elements
    
    Throws:
    
    java.lang.IllegalStateException - if the view is not valid
    
    java.lang.IllegalArgumentException - if the name is empty
  - newInGroupUnsafe
```
public static <E> ListIndexProxy<E> newInGroupUnsafe(java.lang.String groupName,
                                                     byte[] listId,
                                                     View view,
                                                     com.exonum.binding.storage.serialization.Serializer<E> serializer)
```
    Creates a new list in a collection group with the given name.
    See a caveat on index identifiers.
    
    Type Parameters:
    
    E - the type of elements in this list
    
    Parameters:
    
    groupName - a name of the collection group
    
    listId - an identifier of this collection in the group, see the caveats
    
    view - a database view
    
    serializer - a serializer of list elements
    
    Returns:
    
    a new list proxy
    
    Throws:
    
    java.lang.IllegalStateException - if the view is not valid
    
    java.lang.IllegalArgumentException - if the name or index id is empty
  - removeLast
```
public E removeLast()
```
    Removes the last element of the list and returns it.
    
    Returns:
    
    the last element of the list.
    
    Throws:
    
    java.util.NoSuchElementException - if the list is empty
    
    java.lang.IllegalStateException - if this list is not valid
    
    java.lang.UnsupportedOperationException - if this list is read-only
  - truncate
```
public void truncate(long newSize)
```
    Truncates the list, reducing its size to newSize.
    If newSize < size(), keeps the first newSize elements, removing the rest. If newSize >= size(), has no effect.
    
    Parameters:
    
    newSize - the maximum number of elements to keep
    
    Throws:
    
    java.lang.IllegalArgumentException - if the new size is negative
    
    java.lang.IllegalStateException - if this list is not valid
    
    java.lang.UnsupportedOperationException - if this list is read-only
  - getName
```
public java.lang.String getName()
```
    Returns the name of this index.
  - add
```
public final void add(T e)
```
    Description copied from interface: ListIndex
    
    Adds a new element to the end of the list.
    
    Specified by:
    
    add in interface ListIndex<T>
    
    Parameters:
    
    e - an element to append to the list
  - addAll
```
public void addAll(java.util.Collection<? extends T> elements)
```
    Description copied from interface: ListIndex
    
    Adds all elements from the specified collection to this list.
    If the collection contains an invalid element, this list is not modified.
    
    Specified by:
    
    addAll in interface ListIndex<T>
    
    Parameters:
    
    elements - elements to add to this list
  - set
```
public final void set(long index,
                      T e)
```
    Description copied from interface: ListIndex
    
    Replaces the element at the given index of the list with the specified element.
    
    Specified by:
    
    set in interface ListIndex<T>
    
    Parameters:
    
    index - an index of the element to replace
    
    e - an element to add
  - get
```
public final T get(long index)
```
    Description copied from interface: ListIndex
    
    Returns the element at the given index.
    
    Specified by:
    
    get in interface ListIndex<T>
    
    Parameters:
    
    index - an index of the element to return
    
    Returns:
    
    an element at the given index
  - getLast
```
public final T getLast()
```
    Description copied from interface: ListIndex
    
    Returns the last element of the list.
    
    Specified by:
    
    getLast in interface ListIndex<T>
    
    Returns:
    
    the last element of the list
  - clear
```
public final void clear()
```
    Description copied from interface: ListIndex
    
    Clears the list.
    
    Specified by:
    
    clear in interface ListIndex<T>
  - isEmpty
```
public final boolean isEmpty()
```
    Description copied from interface: ListIndex
    
    Returns true if the list is empty, false — otherwise.
    
    Specified by:
    
    isEmpty in interface ListIndex<T>
  - size
```
public final long size()
```
    Description copied from interface: ListIndex
    
    Returns the number of elements in the list.
    
    Specified by:
    
    size in interface ListIndex<T>
  - iterator
```
public final java.util.Iterator<T> iterator()
```
    Description copied from interface: ListIndex
    
    Returns an iterator over the elements of the list.
    Any destructive operation on the same Fork this list uses (but not necessarily on this list) will invalidate the iterator.
    
    Specified by:
    
    iterator in interface ListIndex<T>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<T>
  - getName
```
public final java.lang.String getName()
```
    Returns the name of this index.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ListIndexProxy<E>

Field Summary

Fields inherited from class com.exonum.binding.proxy.AbstractNativeProxy

Method Summary

Methods inherited from class com.exonum.binding.proxy.AbstractNativeProxy

Methods inherited from class java.lang.Object

Methods inherited from interface com.exonum.binding.storage.indices.ListIndex

Methods inherited from interface java.lang.Iterable

Method Detail

newInstance

newInGroupUnsafe

removeLast

truncate

getName

add

addAll

set

get

getLast

clear

isEmpty

size

iterator

getName

toString