Class UpdateMeterInputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.UpdateMeterInputBuilder
Class that builds
UpdateMeterInput
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:
UpdateMeterInput createUpdateMeterInput(int fooXyzzy, int barBaz) {
return new UpdateMeterInputBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of UpdateMeterInput, 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 specifiedTransactionMetadata
.Construct a new builder initialized from specifiedNodeContextRef
.Construct a new builder initialized from specifiedMeterUpdate
.Construct a builder initialized with state from specifiedUpdateMeterInput
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMeterInput> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMeterInput>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull UpdateMeterInput
build()
A newUpdateMeterInput
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toUpdateMeterInput.getMeterRef()
.getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.Return current value associated with the property corresponding toMeterUpdate.getOriginalMeter()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
Return current value associated with the property corresponding toTransactionMetadata.getTransactionUri()
.Return current value associated with the property corresponding toMeterUpdate.getUpdatedMeter()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMeterInput>> augmentationType) Remove an augmentation from this builder's product.setMeterRef
(MeterRef value) Set the property corresponding toUpdateMeterInput.getMeterRef()
to the specified value.Set the property corresponding toNodeContextRef.getNode()
to the specified value.setOriginalMeter
(OriginalMeter value) Set the property corresponding toMeterUpdate.getOriginalMeter()
to the specified value.setTransactionUri
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value) Set the property corresponding toTransactionMetadata.getTransactionUri()
to the specified value.setUpdatedMeter
(UpdatedMeter value) Set the property corresponding toMeterUpdate.getUpdatedMeter()
to the specified value.
-
Constructor Details
-
UpdateMeterInputBuilder
public UpdateMeterInputBuilder()Construct an empty builder. -
UpdateMeterInputBuilder
Construct a new builder initialized from specifiedTransactionMetadata
.- Parameters:
arg
- TransactionMetadata from which the builder should be initialized
-
UpdateMeterInputBuilder
Construct a new builder initialized from specifiedMeterUpdate
.- Parameters:
arg
- MeterUpdate from which the builder should be initialized
-
UpdateMeterInputBuilder
Construct a new builder initialized from specifiedNodeContextRef
.- Parameters:
arg
- NodeContextRef from which the builder should be initialized
-
UpdateMeterInputBuilder
Construct a builder initialized with state from specifiedUpdateMeterInput
.- Parameters:
base
- UpdateMeterInput 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
-
getMeterRef
Return current value associated with the property corresponding toUpdateMeterInput.getMeterRef()
.- Returns:
- current value
-
getNode
Return current value associated with the property corresponding toNodeContextRef.getNode()
.- Returns:
- current value
-
getOriginalMeter
Return current value associated with the property corresponding toMeterUpdate.getOriginalMeter()
.- Returns:
- current value
-
getTransactionUri
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()Return current value associated with the property corresponding toTransactionMetadata.getTransactionUri()
.- Returns:
- current value
-
getUpdatedMeter
Return current value associated with the property corresponding toMeterUpdate.getUpdatedMeter()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMeterInput>> 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
-
setMeterRef
Set the property corresponding toUpdateMeterInput.getMeterRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
Set the property corresponding toNodeContextRef.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOriginalMeter
Set the property corresponding toMeterUpdate.getOriginalMeter()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransactionUri
public UpdateMeterInputBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value) Set the property corresponding toTransactionMetadata.getTransactionUri()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setUpdatedMeter
Set the property corresponding toMeterUpdate.getUpdatedMeter()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public UpdateMeterInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMeterInput> 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 UpdateMeterInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateMeterInput>> 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 newUpdateMeterInput
instance.- Returns:
- A new
UpdateMeterInput
instance.
-