Class MeterBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.MeterBuilder
Class that builds
Meter
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:
Meter createMeter(int fooXyzzy, int barBaz) {
return new MeterBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Meter, 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.MeterBuilder
(Meter base) Construct a builder initialized with state from specifiedMeter
.MeterBuilder
(Meter arg) Construct a new builder initialized from specifiedMeter
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Meter> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Meter>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Meter
build()
A newMeter
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toMeter.getBarrier()
.Return current value associated with the property corresponding toMeter.getContainerName()
.getFlags()
Return current value associated with the property corresponding toMeter.getFlags()
.Return current value associated with the property corresponding toMeter.getMeterBandHeaders()
.Return current value associated with the property corresponding toMeter.getMeterId()
.Return current value associated with the property corresponding toMeter.getMeterName()
.key()
Return current value associated with the property corresponding toMeter.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Meter>> augmentationType) Remove an augmentation from this builder's product.setBarrier
(Boolean value) Set the property corresponding toMeter.getBarrier()
to the specified value.setContainerName
(String value) Set the property corresponding toMeter.getContainerName()
to the specified value.setFlags
(MeterFlags value) Set the property corresponding toMeter.getFlags()
to the specified value.Set the property corresponding toMeter.getMeterBandHeaders()
to the specified value.setMeterId
(MeterId value) Set the property corresponding toMeter.getMeterId()
to the specified value.setMeterName
(String value) Set the property corresponding toMeter.getMeterName()
to the specified value.Set the key value corresponding toMeter.key()
to the specified value.
-
Constructor Details
-
MeterBuilder
public MeterBuilder()Construct an empty builder. -
MeterBuilder
Construct a new builder initialized from specifiedMeter
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.Meter from which the builder should be initialized
-
MeterBuilder
Construct a builder initialized with state from specifiedMeter
.- Parameters:
base
- Meter 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 toMeter.key()
.- Returns:
- current value
-
getBarrier
Return current value associated with the property corresponding toMeter.getBarrier()
.- Returns:
- current value
-
getContainerName
Return current value associated with the property corresponding toMeter.getContainerName()
.- Returns:
- current value
-
getFlags
Return current value associated with the property corresponding toMeter.getFlags()
.- Returns:
- current value
-
getMeterBandHeaders
Return current value associated with the property corresponding toMeter.getMeterBandHeaders()
.- Returns:
- current value
-
getMeterId
Return current value associated with the property corresponding toMeter.getMeterId()
.- Returns:
- current value
-
getMeterName
Return current value associated with the property corresponding toMeter.getMeterName()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Meter>> 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 toMeter.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setBarrier
Set the property corresponding toMeter.getBarrier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setContainerName
Set the property corresponding toMeter.getContainerName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
Set the property corresponding toMeter.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterBandHeaders
Set the property corresponding toMeter.getMeterBandHeaders()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterId
Set the property corresponding toMeter.getMeterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMeterName
Set the property corresponding toMeter.getMeterName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MeterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Meter> 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 MeterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Meter>> 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 newMeter
instance.- Returns:
- A new
Meter
instance.
-