AtomixConsistentMap (onos-core-primitives 1.5.1 API)

java.lang.Object
- io.atomix.resource.Resource<AtomixConsistentMap>
- - org.onosproject.store.primitives.resources.impl.AtomixConsistentMap

All Implemented Interfaces:

io.atomix.catalyst.util.Managed<AtomixConsistentMap>, org.onosproject.store.service.AsyncConsistentMap<String,byte[]>, org.onosproject.store.service.DistributedPrimitive
```
public class AtomixConsistentMap
extends io.atomix.resource.Resource<AtomixConsistentMap>
implements org.onosproject.store.service.AsyncConsistentMap<String,byte[]>
```
Distributed resource providing the AsyncConsistentMap primitive.

Nested Class Summary
- Nested classes/interfaces inherited from class io.atomix.resource.Resource
  io.atomix.resource.Resource.Config, io.atomix.resource.Resource.Options, io.atomix.resource.Resource.State
- Nested classes/interfaces inherited from interface org.onosproject.store.service.DistributedPrimitive
  org.onosproject.store.service.DistributedPrimitive.Type

Field Summary

Fields
Modifier and Type Field and Description

static String CHANGE_SUBJECT
- Fields inherited from class io.atomix.resource.Resource
  client, options
- Fields inherited from interface org.onosproject.store.service.DistributedPrimitive
  DEFAULT_OPERTATION_TIMEOUT_MILLIS

Fields
Modifier and Type	Field and Description
`static String`	`CHANGE_SUBJECT`

Constructor Summary

Constructors
Constructor and Description

AtomixConsistentMap(io.atomix.copycat.client.CopycatClient client, io.atomix.resource.Resource.Options options)

Constructors
Constructor and Description
`AtomixConsistentMap(io.atomix.copycat.client.CopycatClient client, io.atomix.resource.Resource.Options options)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletableFuture<Void>`	`addListener(org.onosproject.store.service.MapEventListener<String,byte[]> listener)`
`CompletableFuture<Void>`	`clear()`
`CompletableFuture<Void>`	`commit(org.onosproject.store.primitives.TransactionId transactionId)`
`CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>`	`computeIf(String key, Predicate<? super byte[]> condition, BiFunction<? super String,? super byte[],? extends byte[]> remappingFunction)`
`CompletableFuture<Boolean>`	`containsKey(String key)`
`CompletableFuture<Boolean>`	`containsValue(byte[] value)`
`CompletableFuture<Set<Map.Entry<String,org.onosproject.store.service.Versioned<byte[]>>>>`	`entrySet()`
`CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>`	`get(String key)`
`CompletableFuture<Boolean>`	`isEmpty()`
`CompletableFuture<Set<String>>`	`keySet()`
`String`	`name()`
`CompletableFuture<AtomixConsistentMap>`	`open()`
`CompletableFuture<Boolean>`	`prepare(org.onosproject.store.service.MapTransaction<String,byte[]> transaction)`
`CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>`	`put(String key, byte[] value)`
`CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>`	`putAndGet(String key, byte[] value)`
`CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>`	`putIfAbsent(String key, byte[] value)`
`CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>`	`remove(String key)`
`CompletableFuture<Boolean>`	`remove(String key, byte[] value)`
`CompletableFuture<Boolean>`	`remove(String key, long version)`
`CompletableFuture<Void>`	`removeListener(org.onosproject.store.service.MapEventListener<String,byte[]> listener)`
`CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>`	`replace(String key, byte[] value)`
`CompletableFuture<Boolean>`	`replace(String key, byte[] oldValue, byte[] newValue)`
`CompletableFuture<Boolean>`	`replace(String key, long oldVersion, byte[] newValue)`
`CompletableFuture<Void>`	`rollback(org.onosproject.store.primitives.TransactionId transactionId)`
`CompletableFuture<Integer>`	`size()`
`CompletableFuture<Collection<org.onosproject.store.service.Versioned<byte[]>>>`	`values()`

Methods inherited from class io.atomix.resource.Resource
close, configure, context, delete, equals, hashCode, isClosed, isOpen, onStateChange, readConsistency, state, submit, submit, submit, submit, toString, type, with, with, writeConsistency

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

Methods inherited from interface org.onosproject.store.service.AsyncConsistentMap
asConsistentMap, asConsistentMap, compute, computeIfAbsent, computeIfPresent, destroy, primitiveType

Methods inherited from interface org.onosproject.store.service.DistributedPrimitive
applicationId

Field Detail
- CHANGE_SUBJECT
```
public static final String CHANGE_SUBJECT
```
  See Also:
  
  Constant Field Values

Constructor Detail

AtomixConsistentMap

public AtomixConsistentMap(io.atomix.copycat.client.CopycatClient client,
                           io.atomix.resource.Resource.Options options)

Method Detail

name
```
public String name()
```
Specified by:

name in interface org.onosproject.store.service.DistributedPrimitive

open
```
public CompletableFuture<AtomixConsistentMap> open()
```
Specified by:

open in interface io.atomix.catalyst.util.Managed<AtomixConsistentMap>

Overrides:

open in class io.atomix.resource.Resource<AtomixConsistentMap>

isEmpty
```
public CompletableFuture<Boolean> isEmpty()
```
Specified by:

isEmpty in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

size
```
public CompletableFuture<Integer> size()
```
Specified by:

size in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

containsKey
```
public CompletableFuture<Boolean> containsKey(String key)
```
Specified by:

containsKey in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

containsValue
```
public CompletableFuture<Boolean> containsValue(byte[] value)
```
Specified by:

containsValue in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

get

public CompletableFuture<org.onosproject.store.service.Versioned<byte[]>> get(String key)

Specified by:: get in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

keySet
```
public CompletableFuture<Set<String>> keySet()
```
Specified by:

keySet in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

values
```
public CompletableFuture<Collection<org.onosproject.store.service.Versioned<byte[]>>> values()
```
Specified by:

values in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

entrySet

public CompletableFuture<Set<Map.Entry<String,org.onosproject.store.service.Versioned<byte[]>>>> entrySet()

Specified by:: entrySet in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

put

public CompletableFuture<org.onosproject.store.service.Versioned<byte[]>> put(String key,
                                                                              byte[] value)

Specified by:: put in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

putAndGet

public CompletableFuture<org.onosproject.store.service.Versioned<byte[]>> putAndGet(String key,
                                                                                    byte[] value)

Specified by:: putAndGet in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

putIfAbsent

public CompletableFuture<org.onosproject.store.service.Versioned<byte[]>> putIfAbsent(String key,
                                                                                      byte[] value)

Specified by:: putIfAbsent in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

remove
```
public CompletableFuture<org.onosproject.store.service.Versioned<byte[]>> remove(String key)
```
Specified by:

remove in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

remove

public CompletableFuture<Boolean> remove(String key,
                                         byte[] value)

Specified by:: remove in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

remove

public CompletableFuture<Boolean> remove(String key,
                                         long version)

Specified by:: remove in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

replace

public CompletableFuture<org.onosproject.store.service.Versioned<byte[]>> replace(String key,
                                                                                  byte[] value)

Specified by:: replace in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

replace

public CompletableFuture<Boolean> replace(String key,
                                          byte[] oldValue,
                                          byte[] newValue)

Specified by:: replace in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

replace

public CompletableFuture<Boolean> replace(String key,
                                          long oldVersion,
                                          byte[] newValue)

Specified by:: replace in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

clear
```
public CompletableFuture<Void> clear()
```
Specified by:

clear in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

computeIf

public CompletableFuture<org.onosproject.store.service.Versioned<byte[]>> computeIf(String key,
                                                                                    Predicate<? super byte[]> condition,
                                                                                    BiFunction<? super String,? super byte[],? extends byte[]> remappingFunction)

Specified by:: computeIf in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

addListener

public CompletableFuture<Void> addListener(org.onosproject.store.service.MapEventListener<String,byte[]> listener)

Specified by:: addListener in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

removeListener

public CompletableFuture<Void> removeListener(org.onosproject.store.service.MapEventListener<String,byte[]> listener)

Specified by:: removeListener in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

prepare

public CompletableFuture<Boolean> prepare(org.onosproject.store.service.MapTransaction<String,byte[]> transaction)

Specified by:: prepare in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

commit

public CompletableFuture<Void> commit(org.onosproject.store.primitives.TransactionId transactionId)

Specified by:: commit in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

rollback

public CompletableFuture<Void> rollback(org.onosproject.store.primitives.TransactionId transactionId)

Specified by:: rollback in interface org.onosproject.store.service.AsyncConsistentMap<String,byte[]>

Class AtomixConsistentMap

Nested Class Summary

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

Nested classes/interfaces inherited from interface org.onosproject.store.service.DistributedPrimitive

Field Summary

Fields inherited from class io.atomix.resource.Resource

Fields inherited from interface org.onosproject.store.service.DistributedPrimitive

Constructor Summary

Method Summary

Methods inherited from class io.atomix.resource.Resource

Methods inherited from class java.lang.Object

Methods inherited from interface org.onosproject.store.service.AsyncConsistentMap

Methods inherited from interface org.onosproject.store.service.DistributedPrimitive

Field Detail

CHANGE_SUBJECT

Constructor Detail

AtomixConsistentMap

Method Detail

name

open

isEmpty

size

containsKey

containsValue

get

keySet

values

entrySet

put

putAndGet

putIfAbsent

remove

remove

remove

replace

replace

replace

clear

computeIf

addListener

removeListener

prepare

commit

rollback