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