DistributedPrimitiveBuilder (onos-api)

java.lang.Object
- org.onosproject.store.primitives.DistributedPrimitiveBuilder<B,T>

Type Parameters:

T - distributed primitive type

Direct Known Subclasses:

AtomicCounterBuilder, AtomicCounterMapBuilder, AtomicIdGeneratorBuilder, AtomicValueBuilder, ConsistentMapBuilder, ConsistentMultimapBuilder, ConsistentTreeMapBuilder, DistributedSetBuilder, DocumentTreeBuilder, LeaderElectorBuilder, TransactionContextBuilder
```
public abstract class DistributedPrimitiveBuilder<B extends DistributedPrimitiveBuilder<B,T>,T extends DistributedPrimitive>
extends Object
```
Abstract builder for distributed primitives.

Constructor Summary

Constructors
Constructor and Description

DistributedPrimitiveBuilder(DistributedPrimitive.Type type)

Constructors
Constructor and Description
`DistributedPrimitiveBuilder(DistributedPrimitive.Type type)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ApplicationId`	`applicationId()` Returns the application identifier.
`abstract T`	`build()` Constructs an instance of the distributed primitive.
`Supplier<Executor>`	`executorSupplier()` Returns the executor supplier.
`boolean`	`meteringEnabled()` Returns if metering is enabled.
`String`	`name()` Returns the name of the primitive.
`boolean`	`partitionsDisabled()` Returns if partitions are disabled.
`boolean`	`readOnly()` Returns if updates are disabled.
`boolean`	`relaxedReadConsistency()` Returns if consistency is relaxed for read operations.
`Serializer`	`serializer()` Returns the serializer.
`DistributedPrimitive.Type`	`type()` Returns the primitive type.
`B`	`withApplicationId(ApplicationId applicationId)` Sets the application id that owns this primitive.
`B`	`withExecutor(Executor executor)` Sets the executor to use for asynchronous callbacks.
`B`	`withExecutorSupplier(Supplier<Executor> executorSupplier)` Sets the supplier to be used to create executors.
`B`	`withMeteringDisabled()` Deprecated. usage of this method is discouraged for most common scenarios.
`B`	`withName(String name)` Sets the primitive name.
`B`	`withRelaxedReadConsistency()` Turns on relaxed consistency for read operations.
`B`	`withSerializer(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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DistributedPrimitiveBuilder
```
public DistributedPrimitiveBuilder(DistributedPrimitive.Type type)
```
- Method Detail
  - withName
```
public B withName(String name)
```
    Sets the primitive name.
    
    Parameters:
    
    name - primitive name
    
    Returns:
    
    this builder
  - withSerializer
```
public B withSerializer(Serializer serializer)
```
    Sets the serializer to use for transcoding info held in the primitive.
    
    Parameters:
    
    serializer - serializer
    
    Returns:
    
    this builder
  - withExecutor
```
public B withExecutor(Executor executor)
```
    Sets the executor to use for asynchronous callbacks.
    For partitioned primitives, the provided executor will be shared across all partitions.
    
    Parameters:
    
    executor - the executor to use for asynchronous callbacks
    
    Returns:
    
    this builder
  - withExecutorSupplier
```
public B withExecutorSupplier(Supplier<Executor> executorSupplier)
```
    Sets the supplier to be used to create executors.
    When a factory is set, the supplier will be used to create a separate executor for each partition.
    
    Parameters:
    
    executorSupplier - the executor supplier
    
    Returns:
    
    this builder
  - withApplicationId
```
public B withApplicationId(ApplicationId applicationId)
```
    Sets the application id that owns this primitive.
    
    Parameters:
    
    applicationId - application identifier
    
    Returns:
    
    this builder
  - withMeteringDisabled
```
@Deprecated
public B withMeteringDisabled()
```
    Deprecated. usage of this method is discouraged for most common scenarios.
    
    Disables recording usage stats for this primitive.
    
    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
  - meteringEnabled
```
public final boolean meteringEnabled()
```
    Returns if metering is enabled.
    
    Returns:
    
    true if yes; false otherwise
  - partitionsDisabled
```
public final boolean partitionsDisabled()
```
    Returns if partitions are disabled.
    
    Returns:
    
    true if yes; false otherwise
  - readOnly
```
public final boolean readOnly()
```
    Returns if updates are disabled.
    
    Returns:
    
    true if yes; false otherwise
  - relaxedReadConsistency
```
public final boolean relaxedReadConsistency()
```
    Returns if consistency is relaxed for read operations.
    
    Returns:
    
    true if yes; false otherwise
  - serializer
```
public final Serializer serializer()
```
    Returns the serializer.
    
    Returns:
    
    serializer
  - executorSupplier
```
public final Supplier<Executor> executorSupplier()
```
    Returns the executor supplier.
    
    Returns:
    
    executor supplier
  - applicationId
```
public final ApplicationId applicationId()
```
    Returns the application identifier.
    
    Returns:
    
    application id
  - name
```
public final String name()
```
    Returns the name of the primitive.
    
    Returns:
    
    primitive name
  - type
```
public final DistributedPrimitive.Type type()
```
    Returns the primitive type.
    
    Returns:
    
    primitive type
  - build
```
public abstract T build()
```
    Constructs an instance of the distributed primitive.
    
    Returns:
    
    distributed primitive

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DistributedPrimitiveBuilder

Method Detail

withName

withSerializer

withExecutor

withExecutorSupplier

withApplicationId

withMeteringDisabled

withUpdatesDisabled

withRelaxedReadConsistency

meteringEnabled

partitionsDisabled

readOnly

relaxedReadConsistency

serializer

executorSupplier

applicationId

name

type

build