Package org.apache.ignite.configuration

Interface NamedListChange<VIEWT,CHANGET extends VIEWT>

Type Parameters:

VIEWT - Type for the reading named list elements of this particular list.

CHANGET - Type for changing named list elements of this particular list.

All Superinterfaces:

Iterable<VIEWT>, NamedListView<VIEWT>

public interface NamedListChange<VIEWT,CHANGET extends VIEWT>
extends NamedListView<VIEWT>

Closure parameter for ConfigurationTree.change(Consumer) method. Contains methods to modify named lists.

Method Summary

Modifier and Type	Method	Description
NamedListChange<VIEWT,CHANGET>	create(int index, String key, Consumer<CHANGET> valConsumer)	Creates a new value at the given position in the named list configuration.
NamedListChange<VIEWT,CHANGET>	create(String key, Consumer<CHANGET> valConsumer)	Creates a new value in the named list configuration.
NamedListChange<VIEWT,CHANGET>	createAfter(String precedingKey, String key, Consumer<CHANGET> valConsumer)	Create a new value after a given precedingKey key in the named list configuration.
NamedListChange<VIEWT,CHANGET>	createOrUpdate(String key, Consumer<CHANGET> valConsumer)	Updates a value in the named list configuration.
NamedListChange<VIEWT,CHANGET>	delete(String key)	Removes the value from the named list configuration.
NamedListChange<VIEWT,CHANGET>	rename(String oldKey, String newKey)	Renames the existing value in the named list configuration.
NamedListChange<VIEWT,CHANGET>	update(String key, Consumer<CHANGET> valConsumer)	Updates a value in the named list configuration.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.apache.ignite.configuration.NamedListView

get, get, get, isEmpty, iterator, namedListKeys, size, stream

Method Details

create

NamedListChange<VIEWT,CHANGET> create(String key,
 Consumer<CHANGET> valConsumer)

Creates a new value in the named list configuration.

Parameters:

key - Key for the value to be created.

valConsumer - Closure to modify the value associated with the key. Closure parameter must not be leaked outside the scope of the closure.

Returns:

this for chaining.

Throws:

NullPointerException - If one of the parameters is null.

IllegalArgumentException - If an element with the given name already exists.

create

NamedListChange<VIEWT,CHANGET> create(int index,
 String key,
 Consumer<CHANGET> valConsumer)

Creates a new value at the given position in the named list configuration.

Parameters:

index - Index of the inserted element.

key - Key for the value to be created.

valConsumer - Closure to modify the value associated with the key. Closure parameter must not be leaked outside the scope of the closure.

Returns:

this for chaining.

Throws:

NullPointerException - If one of the parameters is null.

IndexOutOfBoundsException - If index is negative of exceeds the size of the list.

IllegalArgumentException - If an element with the given name already exists.

createAfter

NamedListChange<VIEWT,CHANGET> createAfter(String precedingKey,
 String key,
 Consumer<CHANGET> valConsumer)

Create a new value after a given precedingKey key in the named list configuration.

Parameters:

precedingKey - Name of the preceding element.

key - Key for the value to be created.

valConsumer - Closure to modify the value associated with the key. Closure parameter must not be leaked outside the scope of the closure.

Returns:

this for chaining.

Throws:

NullPointerException - If one of parameters is null.

IllegalArgumentException - If element with given name already exists or if precedingKey element doesn't exist.

createOrUpdate

NamedListChange<VIEWT,CHANGET> createOrUpdate(String key,
 Consumer<CHANGET> valConsumer)

Updates a value in the named list configuration. If the value cannot be found, creates a new one instead.

Parameters:

key - Key for the value to be updated.

valConsumer - Closure to modify the value associated with the key. Closure parameter must not be leaked outside the scope of the closure.

Returns:

this for chaining.

Throws:

NullPointerException - If one of parameters is null.

IllegalArgumentException - If delete(String) has been invoked with the same key previously.

update

NamedListChange<VIEWT,CHANGET> update(String key,
 Consumer<CHANGET> valConsumer)

Updates a value in the named list configuration.

Parameters:

key - Key for the value to be updated.

valConsumer - Closure to modify the value associated with the key. Closure parameter must not be leaked outside the scope of the closure.

Returns:

this for chaining.

Throws:

NullPointerException - If one of parameters is null.

IllegalArgumentException - If the given key does not exist or if delete(String) has been invoked with the same key previously.

rename

NamedListChange<VIEWT,CHANGET> rename(String oldKey,
 String newKey)

Renames the existing value in the named list configuration. Does nothing if oldKey and newKey are the same. Element with key oldKey must exist and key newKey must not. Error will occur if newKey has just been deleted on the same NamedListChange instance (to distinguish between ConfigurationNamedListListener.onRename(ConfigurationNotificationEvent) and ConfigurationNamedListListener.onUpdate(ConfigurationNotificationEvent) on newKey).

Parameters:

oldKey - Key for the value to be updated.

newKey - New key for the same value.

Returns:

this for chaining.

Throws:

NullPointerException - If one of parameters is null.

IllegalArgumentException - If an element with name newKey already exists, or an element with name oldKey doesn't exist, or delete(String) has previously been invoked with either the newKey or the oldKey.

delete

NamedListChange<VIEWT,CHANGET> delete(String key)

Removes the value from the named list configuration.

Parameters:

key - Key for the value to be removed.

Returns:

this for chaining.

Throws:

NullPointerException - If key is null.

IllegalArgumentException - If createOrUpdate(String, Consumer) has been invoked with the same key previously.