Class MultipartRequestMeterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.meter._case.MultipartRequestMeterBuilder
-
@Generated("mdsal-binding-generator") public class MultipartRequestMeterBuilder extends Object
Class that buildsMultipartRequestMeter
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:
MultipartRequestMeter createMultipartRequestMeter(int fooXyzzy, int barBaz) { return new MultipartRequestMeterBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MultipartRequestMeter, 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:
MultipartRequestMeter
- 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 MultipartRequestMeterBuilder()
Construct an empty builder.MultipartRequestMeterBuilder(MultipartRequestMeter base)
Construct a builder initialized with state from specifiedMultipartRequestMeter
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MultipartRequestMeterBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestMeter> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestMeter>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MultipartRequestMeter
build()
A newMultipartRequestMeter
instance.MeterId
getMeterId()
Return current value associated with the property corresponding toMultipartRequestMeter.getMeterId()
.MultipartRequestMeterBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestMeter>> augmentationType)
Remove an augmentation from this builder's product.MultipartRequestMeterBuilder
setMeterId(MeterId value)
Set the property corresponding toMultipartRequestMeter.getMeterId()
to the specified value.
-
-
-
Constructor Detail
-
MultipartRequestMeterBuilder
public MultipartRequestMeterBuilder()
Construct an empty builder.
-
MultipartRequestMeterBuilder
public MultipartRequestMeterBuilder(MultipartRequestMeter base)
Construct a builder initialized with state from specifiedMultipartRequestMeter
.- Parameters:
base
- MultipartRequestMeter from which the builder should be initialized
-
-
Method Detail
-
getMeterId
public MeterId getMeterId()
Return current value associated with the property corresponding toMultipartRequestMeter.getMeterId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestMeter>> 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
-
setMeterId
public MultipartRequestMeterBuilder setMeterId(MeterId value)
Set the property corresponding toMultipartRequestMeter.getMeterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MultipartRequestMeterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestMeter> 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 MultipartRequestMeterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestMeter>> 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 MultipartRequestMeter build()
A newMultipartRequestMeter
instance.- Returns:
- A new
MultipartRequestMeter
instance.
-
-