com.hazelcast.client.impl.protocol.template

Interface ListCodecTemplate

public interface ListCodecTemplate

Method Summary

Methods

Modifier and Type	Method and Description
Object	add(String name, Data value) Appends the specified element to the end of this list (optional operation).
Object	addAll(String name, List<Data> valueList) Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation).
Object	addAllWithIndex(String name, int index, List<Data> valueList) Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
Object	addListener(String name, boolean includeValue, boolean localOnly) Adds an item listener for this collection.
void	addWithIndex(String name, int index, Data value) Inserts the specified element at the specified position in this list (optional operation).
void	clear(String name) Removes all of the elements from this list (optional operation).
Object	compareAndRemoveAll(String name, List<Data> values) Removes from this list all of its elements that are contained in the specified collection (optional operation).
Object	compareAndRetainAll(String name, List<Data> values) Retains only the elements in this list that are contained in the specified collection (optional operation).
Object	contains(String name, Data value) Returns true if this list contains the specified element.
Object	containsAll(String name, List<Data> values) Returns true if this list contains all of the elements of the specified collection.
Object	get(String name, int index) Returns the element at the specified position in this list
Object	getAll(String name) Return the all elements of this collection
Object	indexOf(String name, Data value) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
Object	isEmpty(String name) Returns true if this list contains no elements
Object	iterator(String name) Returns an iterator over the elements in this list in proper sequence.
Object	lastIndexOf(String name, Data value) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
Object	listIterator(String name, int index) Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
Object	remove(String name, Data value) Removes the first occurrence of the specified element from this list, if it is present (optional operation).
Object	removeListener(String name, String registrationId) Removes the specified item listener.
Object	removeWithIndex(String name, int index) Removes the element at the specified position in this list (optional operation).
Object	set(String name, int index, Data value) The element previously at the specified position
Object	size(String name) Returns the number of elements in this list.
Object	sub(String name, int from, int to) Returns a view of the portion of this list between the specified from, inclusive, and to, exclusive.(If from and to are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa.

Method Detail

size

Object size(String name)

Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Parameters:

name - Name of List

Returns:

The number of elements in this list

contains

Object contains(String name,
              Data value)

Returns true if this list contains the specified element.

Parameters:

name - Name of the List

value - Element whose presence in this list is to be tested

Returns:

True if this list contains the specified element, false otherwise

containsAll

Object containsAll(String name,
                 List<Data> values)

Returns true if this list contains all of the elements of the specified collection.

Parameters:

name - Name of the List

values - Collection to be checked for containment in this list

Returns:

True if this list contains all of the elements of the specified collection

add

Object add(String name,
         Data value)

Appends the specified element to the end of this list (optional operation). Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added.

Parameters:

name - Name of the List

value - Element to be appended to this list

Returns:

true if this list changed as a result of the call, false otherwise

remove

Object remove(String name,
            Data value)

Removes the first occurrence of the specified element from this list, if it is present (optional operation). If this list does not contain the element, it is unchanged. Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).

Parameters:

name - Name of the List

value - Element to be removed from this list, if present

Returns:

True if this list contained the specified element, false otherwise

addAll

Object addAll(String name,
            List<Data> valueList)

Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation). 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:

name - Name of the List

valueList - Collection containing elements to be added to this list

Returns:

True if this list changed as a result of the call, false otherwise

compareAndRemoveAll

Object compareAndRemoveAll(String name,
                         List<Data> values)

Removes from this list all of its elements that are contained in the specified collection (optional operation).

Parameters:

name - Name of the List

values - The list of values to compare for removal.

Returns:

True if removed at least one of the items, false otherwise.

compareAndRetainAll

Object compareAndRetainAll(String name,
                         List<Data> values)

Retains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all of its elements that are not contained in the specified collection.

Parameters:

name - Name of the List

values - The list of values to compare for retaining.

Returns:

True if this list changed as a result of the call, false otherwise.

clear

void clear(String name)

Removes all of the elements from this list (optional operation). The list will be empty after this call returns.

Parameters:

name - Name of the List

getAll

Object getAll(String name)

Return the all elements of this collection

Parameters:

name - Name of the List

Returns:

An array of all item values in the list.

addListener

Object addListener(String name,
                 boolean includeValue,
                 boolean localOnly)

Adds an item listener for this collection. Listener will be notified for all collection add/remove events.

Parameters:

name - Name of the List

includeValue - Set to true if you want the event to contain the value.

localOnly - if true fires events that originated from this node only, otherwise fires all events

Returns:

Registration id for the listener.

removeListener

Object removeListener(String name,
                    String registrationId)

Removes the specified item listener. Returns silently if the specified listener was not added before.

Parameters:

name - Name of the List

registrationId - The id of the listener which was provided during registration.

Returns:

True if unregistered, false otherwise.

isEmpty

Object isEmpty(String name)

Returns true if this list contains no elements

Parameters:

name - Name of the List

Returns:

True if this list contains no elements

addAllWithIndex

Object addAllWithIndex(String name,
                     int index,
                     List<Data> valueList)

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:

name - Name of the List

index - index at which to insert the first element from the specified collection.

valueList - The list of value to insert into the list.

Returns:

True if this list changed as a result of the call, false otherwise.

get

Object get(String name,
         int index)

Returns the element at the specified position in this list

Parameters:

name - Name of the List

index - Index of the element to return

Returns:

The element at the specified position in this list

set

Object set(String name,
         int index,
         Data value)

The element previously at the specified position

Parameters:

name - Name of the List

index - Index of the element to replace

value - Element to be stored at the specified position

Returns:

The element previously at the specified position

addWithIndex

void addWithIndex(String name,
                int index,
                Data value)

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:

name - Name of the List

index - index at which the specified element is to be inserted

value - Value to be inserted.

removeWithIndex

Object removeWithIndex(String name,
                     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:

name - Name of the List

index - The index of the element to be removed

Returns:

The element previously at the specified position

lastIndexOf

Object lastIndexOf(String name,
                 Data value)

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.

Parameters:

name - Name of the List

value - 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

indexOf

Object indexOf(String name,
             Data value)

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.

Parameters:

name - Name of the List

value - 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

sub

Object sub(String name,
         int from,
         int to)

Returns a view of the portion of this list between the specified from, inclusive, and to, exclusive.(If from and to are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list. This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList. The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list.(Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)

Parameters:

name - Name of the List

from - Low endpoint (inclusive) of the subList

to - High endpoint (exclusive) of the subList

Returns:

A view of the specified range within this list

iterator

Object iterator(String name)

Returns an iterator over the elements in this list in proper sequence.

Parameters:

name - Name of the List

Returns:

An iterator over the elements in this list in proper sequence

listIterator

Object listIterator(String name,
                  int index)

Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list. The specified index indicates the first element that would be returned by an initial call to ListIterator#next next. An initial call to ListIterator#previous previous would return the element with the specified index minus one.

Parameters:

name - Name of the List

index - index of the first element to be returned from the list iterator next

Returns:

a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list