Class BandwidthUsageBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.auto.bandwidth.rev181109.bandwidth.usage.object.BandwidthUsageBuilder
Class that builds
BandwidthUsage
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:
BandwidthUsage createBandwidthUsage(int fooXyzzy, int barBaz) {
return new BandwidthUsageBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of BandwidthUsage, 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.Construct a builder initialized with state from specifiedBandwidthUsage
.Construct a new builder initialized from specifiedBwSamples
.Construct a new builder initialized from specifiedObject
.Construct a new builder initialized from specifiedObjectHeader
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<BandwidthUsage> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BandwidthUsage>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull BandwidthUsage
build()
A newBandwidthUsage
instance.static @NonNull BandwidthUsage
empty()
Get empty instance of BandwidthUsage.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toBwSamples.getBwSample()
.Return current value associated with the property corresponding toObjectHeader.getIgnore()
.Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BandwidthUsage>> augmentationType) Remove an augmentation from this builder's product.setBwSample
(List<Bandwidth> values) Set the property corresponding toBwSamples.getBwSample()
to the specified value.Set the property corresponding toObjectHeader.getIgnore()
to the specified value.setProcessingRule
(Boolean value) Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.
-
Constructor Details
-
BandwidthUsageBuilder
public BandwidthUsageBuilder()Construct an empty builder. -
BandwidthUsageBuilder
Construct a new builder initialized from specifiedObject
.- Parameters:
arg
- Object from which the builder should be initialized
-
BandwidthUsageBuilder
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader from which the builder should be initialized
-
BandwidthUsageBuilder
Construct a new builder initialized from specifiedBwSamples
.- Parameters:
arg
- BwSamples from which the builder should be initialized
-
BandwidthUsageBuilder
Construct a builder initialized with state from specifiedBandwidthUsage
.- Parameters:
base
- BandwidthUsage 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
-
empty
Get empty instance of BandwidthUsage.- Returns:
- An empty
BandwidthUsage
-
getBwSample
Return current value associated with the property corresponding toBwSamples.getBwSample()
.- Returns:
- current value
-
getIgnore
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getProcessingRule
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BandwidthUsage>> 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
-
setBwSample
Set the property corresponding toBwSamples.getBwSample()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setIgnore
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProcessingRule
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BandwidthUsageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BandwidthUsage> 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 BandwidthUsageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BandwidthUsage>> 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 newBandwidthUsage
instance.- Returns:
- A new
BandwidthUsage
instance.
-