Class ReconcileCounterBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.reconciliation.service.rev180227.reconciliation.counter.ReconcileCounterBuilder
Class that builds
ReconcileCounter
instances. Overall design of the class is that of a
fluent interface, where method chaining is used.
In general, this class is supposed to be used like this template:
ReconcileCounter createReconcileCounter(int fooXyzzy, int barBaz) {
return new ReconcileCounterBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of ReconcileCounter, as instances can be freely passed around without worrying about synchronization issues.
As a side note: method chaining results in:
- very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is
on the stack, so further method invocations just need to fill method arguments for the next method
invocation, which is terminated by
build()
, which is then returned from the method - better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
- better optimization opportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
- See Also:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedCounter
.Construct a builder initialized with state from specifiedReconcileCounter
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<ReconcileCounter> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ReconcileCounter>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull ReconcileCounter
build()
A newReconcileCounter
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toCounter.getFailureCount()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime
Return current value associated with the property corresponding toCounter.getLastRequestTime()
.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toReconcileCounter.getNodeId()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toCounter.getSuccessCount()
.key()
Return current value associated with the property corresponding toReconcileCounter.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ReconcileCounter>> augmentationType) Remove an augmentation from this builder's product.setFailureCount
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toCounter.getFailureCount()
to the specified value.setLastRequestTime
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime value) Set the property corresponding toCounter.getLastRequestTime()
to the specified value.setNodeId
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toReconcileCounter.getNodeId()
to the specified value.setSuccessCount
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toCounter.getSuccessCount()
to the specified value.Set the key value corresponding toReconcileCounter.key()
to the specified value.
-
Constructor Details
-
ReconcileCounterBuilder
public ReconcileCounterBuilder()Construct an empty builder. -
ReconcileCounterBuilder
Construct a new builder initialized from specifiedCounter
.- Parameters:
arg
- Counter from which the builder should be initialized
-
ReconcileCounterBuilder
Construct a builder initialized with state from specifiedReconcileCounter
.- Parameters:
base
- ReconcileCounter from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
Return current value associated with the property corresponding toReconcileCounter.key()
.- Returns:
- current value
-
getFailureCount
public org.opendaylight.yangtools.yang.common.Uint32 getFailureCount()Return current value associated with the property corresponding toCounter.getFailureCount()
.- Returns:
- current value
-
getLastRequestTime
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime getLastRequestTime()Return current value associated with the property corresponding toCounter.getLastRequestTime()
.- Returns:
- current value
-
getNodeId
public org.opendaylight.yangtools.yang.common.Uint64 getNodeId()Return current value associated with the property corresponding toReconcileCounter.getNodeId()
.- Returns:
- current value
-
getSuccessCount
public org.opendaylight.yangtools.yang.common.Uint32 getSuccessCount()Return current value associated with the property corresponding toCounter.getSuccessCount()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ReconcileCounter>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
Set the key value corresponding toReconcileCounter.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setFailureCount
Set the property corresponding toCounter.getFailureCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLastRequestTime
public ReconcileCounterBuilder setLastRequestTime(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime value) Set the property corresponding toCounter.getLastRequestTime()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNodeId
Set the property corresponding toReconcileCounter.getNodeId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSuccessCount
Set the property corresponding toCounter.getSuccessCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ReconcileCounterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ReconcileCounter> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public ReconcileCounterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ReconcileCounter>> augmentationType) Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
A newReconcileCounter
instance.- Returns:
- A new
ReconcileCounter
instance.
-