Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.ted.rev131021.ted.link.attributes
Class UnreservedBandwidthBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.ted.rev131021.ted.link.attributes.UnreservedBandwidthBuilder
-
@Generated("mdsal-binding-generator") public class UnreservedBandwidthBuilder extends Object
Class that buildsUnreservedBandwidth
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:
UnreservedBandwidth
- 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 UnreservedBandwidthBuilder()
Construct an empty builder.UnreservedBandwidthBuilder(UnreservedBandwidth base)
Construct a builder initialized with state from specifiedUnreservedBandwidth
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UnreservedBandwidthBuilder
addAugmentation(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.org.opendaylight.yangtools.yang.common.Decimal64
getBandwidth()
Return current value associated with the property corresponding toUnreservedBandwidth.getBandwidth()
.org.opendaylight.yangtools.yang.common.Uint8
getPriority()
Return current value associated with the property corresponding toUnreservedBandwidth.getPriority()
.UnreservedBandwidthKey
key()
Return current value associated with the property corresponding toUnreservedBandwidth.key()
.UnreservedBandwidthBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreservedBandwidth>> augmentationType)
Remove an augmentation from this builder's product.UnreservedBandwidthBuilder
setBandwidth(org.opendaylight.yangtools.yang.common.Decimal64 value)
Set the property corresponding toUnreservedBandwidth.getBandwidth()
to the specified value.UnreservedBandwidthBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toUnreservedBandwidth.getPriority()
to the specified value.UnreservedBandwidthBuilder
withKey(UnreservedBandwidthKey key)
-
-
-
Constructor Detail
-
UnreservedBandwidthBuilder
public UnreservedBandwidthBuilder()
Construct an empty builder.
-
UnreservedBandwidthBuilder
public UnreservedBandwidthBuilder(UnreservedBandwidth base)
Construct a builder initialized with state from specifiedUnreservedBandwidth
.- Parameters:
base
- UnreservedBandwidth from which the builder should be initialized
-
-
Method Detail
-
key
public UnreservedBandwidthKey key()
Return current value associated with the property corresponding toUnreservedBandwidth.key()
.- Returns:
- current value
-
getBandwidth
public org.opendaylight.yangtools.yang.common.Decimal64 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
public UnreservedBandwidthBuilder withKey(UnreservedBandwidthKey key)
-
setBandwidth
public UnreservedBandwidthBuilder setBandwidth(org.opendaylight.yangtools.yang.common.Decimal64 value)
Set the property corresponding toUnreservedBandwidth.getBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPriority
public UnreservedBandwidthBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
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
public @NonNull UnreservedBandwidth build()
A newUnreservedBandwidth
instance.- Returns:
- A new
UnreservedBandwidth
instance.
-
-