DistributedSet (Atomix API Reference (1.0.8))

java.lang.Object
- io.atomix.resource.AbstractResource<DistributedSet<T>>
- - io.atomix.collections.DistributedSet<T>

Type Parameters:

T - The set value type.

All Implemented Interfaces:

Managed<DistributedSet<T>>, io.atomix.resource.Resource<DistributedSet<T>>
```
public class DistributedSet<T>
extends io.atomix.resource.AbstractResource<DistributedSet<T>>
```
Distributed collection of unique values.
The distributed set is closely modeled on Java's HashSet. All methods present in the Set interface are present in this interface. Set items are held in memory on each stateful node and backed by replicated logs on disk, thus the size of a set is limited by the memory available to the smallest node in the cluster. Internally, DistributedSet uses a HashMap to store set items in memory in the replicated state machine.
To create a distributed set, use the getSet factory method:
```
   
   DistributedSet<String> set = atomix.getSet("foo").get();
   
 
```
All set modification operations are linearizable, so items added to or removed from the set will be immediately reflected from the perspective of all clients operating on the set. The set is shared by processes based on the set name.
Sets support relaxed consistency levels for some read operations line size(ReadConsistency) and contains(Object, ReadConsistency). By default, read operations on a set are linearizable but require some level of communication between nodes.
Author:

Jordan Halterman

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DistributedSet.Events` Distributed set event types.
`static class`	`DistributedSet.ValueEvent<T>` Generic set value event.

Nested classes/interfaces inherited from interface io.atomix.resource.Resource
io.atomix.resource.Resource.Config, io.atomix.resource.Resource.Event, io.atomix.resource.Resource.EventType, io.atomix.resource.Resource.Options, io.atomix.resource.Resource.State

Constructor Summary

Constructors
Constructor and Description

DistributedSet(CopycatClient client, Properties options)

Constructors
Constructor and Description
`DistributedSet(CopycatClient client, Properties options)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletableFuture<Boolean>`	`add(T value)` Adds a value to the set.
`CompletableFuture<Boolean>`	`add(T value, Duration ttl)` Adds a value to the set with a TTL.
`CompletableFuture<Void>`	`clear()` Removes all values from the set.
`CompletableFuture<Boolean>`	`contains(Object value)` Checks whether the set contains a value.
`CompletableFuture<Boolean>`	`contains(Object value, io.atomix.resource.ReadConsistency consistency)` Checks whether the set contains a value.
`CompletableFuture<Boolean>`	`isEmpty()` Checks whether the set is empty.
`CompletableFuture<Boolean>`	`isEmpty(io.atomix.resource.ReadConsistency consistency)` Checks whether the set is empty.
`CompletableFuture<Iterator<T>>`	`iterator()` Returns an Iterator over the values in the set.
`CompletableFuture<Listener<DistributedSet.ValueEvent<T>>>`	`onAdd(Consumer<DistributedSet.ValueEvent<T>> callback)` Registers a queue item add event listener.
`CompletableFuture<Listener<DistributedSet.ValueEvent<T>>>`	`onRemove(Consumer<DistributedSet.ValueEvent<T>> callback)` Registers a queue item remove event listener.
`CompletableFuture<Boolean>`	`remove(T value)` Removes a value from the set.
`CompletableFuture<Integer>`	`size()` Gets the set count.
`CompletableFuture<Integer>`	`size(io.atomix.resource.ReadConsistency consistency)` Gets the set count.

Methods inherited from class io.atomix.resource.AbstractResource
close, config, context, delete, equals, hashCode, isClosed, isOpen, onRecovery, onStateChange, open, options, serializer, state, toString, type

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

- Constructor Detail
  - DistributedSet
```
public DistributedSet(CopycatClient client,
                      Properties options)
```
- Method Detail
  - add
```
public CompletableFuture<Boolean> add(T value)
```
    Adds a value to the set.
    
    Parameters:
    
    value - The value to add.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - add
```
public CompletableFuture<Boolean> add(T value,
                                      Duration ttl)
```
    Adds a value to the set with a TTL.
    
    Parameters:
    
    value - The value to add.
    
    ttl - The time to live duration.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - remove
```
public CompletableFuture<Boolean> remove(T value)
```
    Removes a value from the set.
    
    Parameters:
    
    value - The value to remove.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - contains
```
public CompletableFuture<Boolean> contains(Object value)
```
    Checks whether the set contains a value.
    
    Parameters:
    
    value - The value to check.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - contains
```
public CompletableFuture<Boolean> contains(Object value,
                                           io.atomix.resource.ReadConsistency consistency)
```
    Checks whether the set contains a value.
    
    Parameters:
    
    value - The value to check.
    
    consistency - The read consistency level.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - size
```
public CompletableFuture<Integer> size()
```
    Gets the set count.
    
    Returns:
    
    A completable future to be completed with the set count.
  - size
```
public CompletableFuture<Integer> size(io.atomix.resource.ReadConsistency consistency)
```
    Gets the set count.
    
    Parameters:
    
    consistency - The read consistency level.
    
    Returns:
    
    A completable future to be completed with the set count.
  - isEmpty
```
public CompletableFuture<Boolean> isEmpty()
```
    Checks whether the set is empty.
    
    Returns:
    
    A completable future to be completed with a boolean value indicating whether the set is empty.
  - isEmpty
```
public CompletableFuture<Boolean> isEmpty(io.atomix.resource.ReadConsistency consistency)
```
    Checks whether the set is empty.
    
    Parameters:
    
    consistency - The read consistency level.
    
    Returns:
    
    A completable future to be completed with a boolean value indicating whether the set is empty.
  - iterator
```
public CompletableFuture<Iterator<T>> iterator()
```
    Returns an Iterator over the values in the set.
    
    Returns:
    
    A CompletableFuture to be completed when the iterator is available
  - clear
```
public CompletableFuture<Void> clear()
```
    Removes all values from the set.
    
    Returns:
    
    A completable future to be completed once the operation is complete.
  - onAdd
```
public CompletableFuture<Listener<DistributedSet.ValueEvent<T>>> onAdd(Consumer<DistributedSet.ValueEvent<T>> callback)
```
    Registers a queue item add event listener.
    
    Parameters:
    
    callback - The event listener callback to be called when an item is added to the queue.
    
    Returns:
    
    A completable future to be completed once the listener has been registered with the cluster.
  - onRemove
```
public CompletableFuture<Listener<DistributedSet.ValueEvent<T>>> onRemove(Consumer<DistributedSet.ValueEvent<T>> callback)
```
    Registers a queue item remove event listener.
    
    Parameters:
    
    callback - The event listener callback to be called when an item is removed from the queue.
    
    Returns:
    
    A completable future to be completed once the listener has been registered with the cluster.

Class DistributedSet<T>

Nested Class Summary

Nested classes/interfaces inherited from interface io.atomix.resource.Resource

Constructor Summary

Method Summary

Methods inherited from class io.atomix.resource.AbstractResource

Methods inherited from class java.lang.Object

Constructor Detail

DistributedSet

Method Detail

add

add

remove

contains

contains

size

size

isEmpty

isEmpty

iterator

clear

onAdd

onRemove