Class UpdatedMeterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.meter.update.UpdatedMeterBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<UpdatedMeter>
,org.opendaylight.yangtools.concepts.CheckedBuilder<UpdatedMeter,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class UpdatedMeterBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<UpdatedMeter>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description UpdatedMeterBuilder()
UpdatedMeterBuilder(UpdatedMeter base)
UpdatedMeterBuilder(Meter arg)
-
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)
UpdatedMeter
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrier()
String
getContainerName()
MeterFlags
getFlags()
MeterBandHeaders
getMeterBandHeaders()
MeterId
getMeterId()
String
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)
UpdatedMeterBuilder
setContainerName(String value)
UpdatedMeterBuilder
setFlags(MeterFlags value)
UpdatedMeterBuilder
setMeterBandHeaders(MeterBandHeaders value)
UpdatedMeterBuilder
setMeterId(MeterId value)
UpdatedMeterBuilder
setMeterName(String value)
-
-
-
Constructor Detail
-
UpdatedMeterBuilder
public UpdatedMeterBuilder()
-
UpdatedMeterBuilder
public UpdatedMeterBuilder(Meter arg)
-
UpdatedMeterBuilder
public UpdatedMeterBuilder(UpdatedMeter base)
-
-
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:- Meter
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBarrier
public Boolean getBarrier()
-
getContainerName
public String getContainerName()
-
getFlags
public MeterFlags getFlags()
-
getMeterBandHeaders
public MeterBandHeaders getMeterBandHeaders()
-
getMeterId
public MeterId getMeterId()
-
getMeterName
public String getMeterName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdatedMeter>> E$$ augmentation(Class<E$$> augmentationType)
-
setBarrier
public UpdatedMeterBuilder setBarrier(Boolean value)
-
setContainerName
public UpdatedMeterBuilder setContainerName(String value)
-
setFlags
public UpdatedMeterBuilder setFlags(MeterFlags value)
-
setMeterBandHeaders
public UpdatedMeterBuilder setMeterBandHeaders(MeterBandHeaders value)
-
setMeterId
public UpdatedMeterBuilder setMeterId(MeterId value)
-
setMeterName
public UpdatedMeterBuilder setMeterName(String value)
-
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 UpdatedMeter build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<UpdatedMeter>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<UpdatedMeter,IllegalArgumentException>
-
-