Class UnreservedBandwidthBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.attribute.UnreservedBandwidthBuilder
Class that builds
UnreservedBandwidth
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:
UnreservedBandwidth createUnreservedBandwidth(int fooXyzzy, int barBaz) {
return new UnreservedBandwidthBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of UnreservedBandwidth, 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 specifiedUnreservedBandwidth
.Construct a new builder initialized from specifiedUnreservedBandwidth
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<UnreservedBandwidth> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreservedBandwidth>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull UnreservedBandwidth
build()
A newUnreservedBandwidth
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toUnreservedBandwidth.getBandwidth()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toUnreservedBandwidth.getPriority()
.key()
Return current value associated with the property corresponding toUnreservedBandwidth.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreservedBandwidth>> augmentationType) Remove an augmentation from this builder's product.setBandwidth
(Bandwidth value) Set the property corresponding toUnreservedBandwidth.getBandwidth()
to the specified value.setPriority
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toUnreservedBandwidth.getPriority()
to the specified value.Set the key value corresponding toUnreservedBandwidth.key()
to the specified value.
-
Constructor Details
-
UnreservedBandwidthBuilder
public UnreservedBandwidthBuilder()Construct an empty builder. -
UnreservedBandwidthBuilder
Construct a new builder initialized from specifiedUnreservedBandwidth
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.UnreservedBandwidth from which the builder should be initialized
-
UnreservedBandwidthBuilder
Construct a builder initialized with state from specifiedUnreservedBandwidth
.- Parameters:
base
- UnreservedBandwidth 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 toUnreservedBandwidth.key()
.- Returns:
- current value
-
getBandwidth
Return current value associated with the property corresponding toUnreservedBandwidth.getBandwidth()
.- Returns:
- current value
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint8 getPriority()Return current value associated with the property corresponding toUnreservedBandwidth.getPriority()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreservedBandwidth>> 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 toUnreservedBandwidth.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setBandwidth
Set the property corresponding toUnreservedBandwidth.getBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPriority
Set the property corresponding toUnreservedBandwidth.getPriority()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public UnreservedBandwidthBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UnreservedBandwidth> 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 UnreservedBandwidthBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreservedBandwidth>> 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 newUnreservedBandwidth
instance.- Returns:
- A new
UnreservedBandwidth
instance.
-