Class UpdatedMeterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.meter.update.UpdatedMeterBuilder
-
@Generated("mdsal-binding-generator") public class UpdatedMeterBuilder extends Object
Class that buildsUpdatedMeter
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:
UpdatedMeter createUpdatedMeter(int fooXyzzy, int barBaz) { return new UpdatedMeterBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UpdatedMeter, 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:
UpdatedMeter
- 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
-
-
Constructor Summary
Constructors Constructor Description UpdatedMeterBuilder()
Construct an empty builder.UpdatedMeterBuilder(UpdatedMeter base)
Construct a builder initialized with state from specifiedUpdatedMeter
.UpdatedMeterBuilder(Meter arg)
Construct a new builder initialized from specifiedMeter
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UpdatedMeterBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdatedMeter> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdatedMeter>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull UpdatedMeter
build()
A newUpdatedMeter
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrier()
Return current value associated with the property corresponding toMeter.getBarrier()
.String
getContainerName()
Return current value associated with the property corresponding toMeter.getContainerName()
.MeterFlags
getFlags()
Return current value associated with the property corresponding toMeter.getFlags()
.MeterBandHeaders
getMeterBandHeaders()
Return current value associated with the property corresponding toMeter.getMeterBandHeaders()
.MeterId
getMeterId()
Return current value associated with the property corresponding toMeter.getMeterId()
.String
getMeterName()
Return current value associated with the property corresponding toMeter.getMeterName()
.UpdatedMeterBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdatedMeter>> augmentationType)
Remove an augmentation from this builder's product.UpdatedMeterBuilder
setBarrier(Boolean value)
Set the property corresponding toMeter.getBarrier()
to the specified value.UpdatedMeterBuilder
setContainerName(String value)
Set the property corresponding toMeter.getContainerName()
to the specified value.UpdatedMeterBuilder
setFlags(MeterFlags value)
Set the property corresponding toMeter.getFlags()
to the specified value.UpdatedMeterBuilder
setMeterBandHeaders(MeterBandHeaders value)
Set the property corresponding toMeter.getMeterBandHeaders()
to the specified value.UpdatedMeterBuilder
setMeterId(MeterId value)
Set the property corresponding toMeter.getMeterId()
to the specified value.UpdatedMeterBuilder
setMeterName(String value)
Set the property corresponding toMeter.getMeterName()
to the specified value.
-
-
-
Constructor Detail
-
UpdatedMeterBuilder
public UpdatedMeterBuilder()
Construct an empty builder.
-
UpdatedMeterBuilder
public UpdatedMeterBuilder(Meter arg)
Construct a new builder initialized from specifiedMeter
.- Parameters:
arg
- Meter from which the builder should be initialized
-
UpdatedMeterBuilder
public UpdatedMeterBuilder(UpdatedMeter base)
Construct a builder initialized with state from specifiedUpdatedMeter
.- Parameters:
base
- UpdatedMeter from which the builder should be initialized
-
-
Method Detail
-
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
-
getBarrier
public Boolean getBarrier()
Return current value associated with the property corresponding toMeter.getBarrier()
.- Returns:
- current value
-
getContainerName
public String getContainerName()
Return current value associated with the property corresponding toMeter.getContainerName()
.- Returns:
- current value
-
getFlags
public MeterFlags getFlags()
Return current value associated with the property corresponding toMeter.getFlags()
.- Returns:
- current value
-
getMeterBandHeaders
public MeterBandHeaders getMeterBandHeaders()
Return current value associated with the property corresponding toMeter.getMeterBandHeaders()
.- Returns:
- current value
-
getMeterId
public MeterId getMeterId()
Return current value associated with the property corresponding toMeter.getMeterId()
.- Returns:
- current value
-
getMeterName
public String getMeterName()
Return current value associated with the property corresponding toMeter.getMeterName()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdatedMeter>> 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
-
setBarrier
public UpdatedMeterBuilder setBarrier(Boolean value)
Set the property corresponding toMeter.getBarrier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setContainerName
public UpdatedMeterBuilder setContainerName(String value)
Set the property corresponding toMeter.getContainerName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
public UpdatedMeterBuilder setFlags(MeterFlags value)
Set the property corresponding toMeter.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterBandHeaders
public UpdatedMeterBuilder setMeterBandHeaders(MeterBandHeaders value)
Set the property corresponding toMeter.getMeterBandHeaders()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterId
public UpdatedMeterBuilder setMeterId(MeterId value)
Set the property corresponding toMeter.getMeterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterName
public UpdatedMeterBuilder setMeterName(String value)
Set the property corresponding toMeter.getMeterName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public UpdatedMeterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdatedMeter> 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 UpdatedMeterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdatedMeter>> 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
public @NonNull UpdatedMeter build()
A newUpdatedMeter
instance.- Returns:
- A new
UpdatedMeter
instance.
-
-