DistributedPrimitiveBuilder (Atomix API Reference (2.1.0-beta2))

java.lang.Object
- io.atomix.primitive.DistributedPrimitiveBuilder<B,P>

Type Parameters:: B - builder type; P - primitive type

All Implemented Interfaces:: io.atomix.utils.Builder<P>

public abstract class DistributedPrimitiveBuilder<B extends DistributedPrimitiveBuilder<B,P>,P extends DistributedPrimitive>
extends Object
implements io.atomix.utils.Builder<P>

Abstract builder for distributed primitives.

Constructor Summary

Constructors
Constructor and Description

DistributedPrimitiveBuilder(PrimitiveType type, String name)

Constructors
Constructor and Description
`DistributedPrimitiveBuilder(PrimitiveType type, String name)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`backups()` Returns the number of backups for the primitive.
`P`	`build()` Constructs an instance of the distributed primitive.
`abstract CompletableFuture<P>`	`buildAsync()` Constructs an instance of the asynchronous primitive.
`Consistency`	`consistency()` Returns the primitive consistency model.
`int`	`maxRetries()` Returns the maximum number of allowed retries.
`String`	`name()` Returns the name of the primitive.
`Persistence`	`persistence()` Returns the primitive persistence level.
`PrimitiveType`	`primitiveType()` Returns the primitive type.
`PrimitiveProtocol`	`protocol()` Returns the primitive protocol.
`boolean`	`readOnly()` Returns if updates are disabled.
`Recovery`	`recovery()` Returns the recovery strategy.
`boolean`	`relaxedReadConsistency()` Returns if consistency is relaxed for read operations.
`Replication`	`replication()` Returns the replication strategy.
`Duration`	`retryDelay()` Returns the retry delay.
`io.atomix.utils.serializer.Serializer`	`serializer()` Returns the serializer.
`B`	`withBackups(int numBackups)` Sets the number of backups.
`B`	`withConsistency(Consistency consistency)` Sets the primitive consistency model.
`B`	`withMaxRetries(int maxRetries)` Sets the maximum number of operation retries.
`B`	`withPersistence(Persistence persistence)` Sets the primitive persistence level.
`B`	`withProtocol(PrimitiveProtocol protocol)` Sets the primitive protocol.
`B`	`withRecovery(Recovery recovery)` Sets the primitive recovery strategy.
`B`	`withRelaxedReadConsistency()` Turns on relaxed consistency for read operations.
`B`	`withReplication(Replication replication)` Sets the primitive replication strategy.
`B`	`withRetryDelay(Duration retryDelay)` Sets the retry delay.
`B`	`withSerializer(io.atomix.utils.serializer.Serializer serializer)` Sets the serializer to use for transcoding info held in the primitive.
`B`	`withUpdatesDisabled()` Disables state changing operations on the returned distributed primitive.

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

- Constructor Detail
  - DistributedPrimitiveBuilder
```
public DistributedPrimitiveBuilder(PrimitiveType type,
                                   String name)
```
- Method Detail
  - withSerializer
```
public B withSerializer(io.atomix.utils.serializer.Serializer serializer)
```
    Sets the serializer to use for transcoding info held in the primitive.
    
    Parameters:
    
    serializer - serializer
    
    Returns:
    
    this builder
  - withUpdatesDisabled
```
public B withUpdatesDisabled()
```
    Disables state changing operations on the returned distributed primitive.
    
    Returns:
    
    this builder
  - withRelaxedReadConsistency
```
public B withRelaxedReadConsistency()
```
    Turns on relaxed consistency for read operations.
    
    Returns:
    
    this builder
  - withProtocol
```
public B withProtocol(PrimitiveProtocol protocol)
```
    Sets the primitive protocol.
    
    Parameters:
    
    protocol - the primitive protocol
    
    Returns:
    
    the primitive builder
  - withConsistency
```
public B withConsistency(Consistency consistency)
```
    Sets the primitive consistency model.
    
    Parameters:
    
    consistency - the primitive consistency model
    
    Returns:
    
    the primitive builder
    
    Throws:
    
    NullPointerException - if the consistency model is null
  - withPersistence
```
public B withPersistence(Persistence persistence)
```
    Sets the primitive persistence level.
    
    Parameters:
    
    persistence - the primitive persistence level
    
    Returns:
    
    the primitive builder
    
    Throws:
    
    NullPointerException - if the persistence level is null
  - withReplication
```
public B withReplication(Replication replication)
```
    Sets the primitive replication strategy.
    
    Parameters:
    
    replication - the primitive replication strategy
    
    Returns:
    
    the primitive builder
    
    Throws:
    
    NullPointerException - if the replication strategy is null
  - withRecovery
```
public B withRecovery(Recovery recovery)
```
    Sets the primitive recovery strategy.
    
    Parameters:
    
    recovery - the primitive recovery strategy
    
    Returns:
    
    the primitive builder
    
    Throws:
    
    NullPointerException - if the recovery strategy is null
  - withBackups
```
public B withBackups(int numBackups)
```
    Sets the number of backups.
    
    Parameters:
    
    numBackups - the number of backups
    
    Returns:
    
    the primitive builder
    
    Throws:
    
    IllegalArgumentException - if the number of backups is not positive or -1
  - withMaxRetries
```
public B withMaxRetries(int maxRetries)
```
    Sets the maximum number of operation retries.
    
    Parameters:
    
    maxRetries - the maximum number of allowed operation retries
    
    Returns:
    
    this builder
  - withRetryDelay
```
public B withRetryDelay(Duration retryDelay)
```
    Sets the retry delay.
    
    Parameters:
    
    retryDelay - the retry delay
    
    Returns:
    
    this builder
  - readOnly
```
public boolean readOnly()
```
    Returns if updates are disabled.
    
    Returns:
    
    true if yes; false otherwise
  - relaxedReadConsistency
```
public boolean relaxedReadConsistency()
```
    Returns if consistency is relaxed for read operations.
    
    Returns:
    
    true if yes; false otherwise
  - serializer
```
public io.atomix.utils.serializer.Serializer serializer()
```
    Returns the serializer.
    
    Returns:
    
    serializer
  - name
```
public String name()
```
    Returns the name of the primitive.
    
    Returns:
    
    primitive name
  - primitiveType
```
public PrimitiveType primitiveType()
```
    Returns the primitive type.
    
    Returns:
    
    primitive type
  - protocol
```
public PrimitiveProtocol protocol()
```
    Returns the primitive protocol.
    
    Returns:
    
    the primitive protocol
  - consistency
```
public Consistency consistency()
```
    Returns the primitive consistency model.
    
    Returns:
    
    the primitive consistency model
  - persistence
```
public Persistence persistence()
```
    Returns the primitive persistence level.
    
    Returns:
    
    the primitive persistence level
  - replication
```
public Replication replication()
```
    Returns the replication strategy.
    
    Returns:
    
    the replication strategy
  - recovery
```
public Recovery recovery()
```
    Returns the recovery strategy.
    
    Returns:
    
    the recovery strategy
  - backups
```
public int backups()
```
    Returns the number of backups for the primitive.
    
    Returns:
    
    the number of backups for the primitive
  - maxRetries
```
public int maxRetries()
```
    Returns the maximum number of allowed retries.
    
    Returns:
    
    the maximum number of allowed retries
  - retryDelay
```
public Duration retryDelay()
```
    Returns the retry delay.
    
    Returns:
    
    the retry delay
  - build
```
public P build()
```
    Constructs an instance of the distributed primitive.
    
    Specified by:
    
    build in interface io.atomix.utils.Builder<P extends DistributedPrimitive>
    
    Returns:
    
    distributed primitive
  - buildAsync
```
public abstract CompletableFuture<P> buildAsync()
```
    Constructs an instance of the asynchronous primitive.
    
    Returns:
    
    asynchronous distributed primitive

Class DistributedPrimitiveBuilder<B extends DistributedPrimitiveBuilder<B,P>,P extends DistributedPrimitive>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DistributedPrimitiveBuilder

Method Detail

withSerializer

withUpdatesDisabled

withRelaxedReadConsistency

withProtocol

withConsistency

withPersistence

withReplication

withRecovery

withBackups

withMaxRetries

withRetryDelay

readOnly

relaxedReadConsistency

serializer

name

primitiveType

protocol

consistency

persistence

replication

recovery

backups

maxRetries

retryDelay

build

buildAsync