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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<UnreservedBandwidth>
,org.opendaylight.yangtools.concepts.CheckedBuilder<UnreservedBandwidth,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class UnreservedBandwidthBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<UnreservedBandwidth>
Class that buildsUnreservedBandwidthBuilder
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:
UnreservedBandwidthBuilder createTarget(int fooXyzzy, int barBaz) { return new UnreservedBandwidthBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UnreservedBandwidthBuilder, 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 oportunities, 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:
UnreservedBandwidthBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description UnreservedBandwidthBuilder()
UnreservedBandwidthBuilder(UnreservedBandwidth base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
UnreservedBandwidth
build()
BigDecimal
getBandwidth()
org.opendaylight.yangtools.yang.common.Uint8
getPriority()
UnreservedBandwidthKey
key()
UnreservedBandwidthBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreservedBandwidth>> augmentationType)
Remove an augmentation from this builder's product.UnreservedBandwidthBuilder
setBandwidth(BigDecimal value)
UnreservedBandwidthBuilder
setPriority(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPriority(Uint8)
instead.UnreservedBandwidthBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
UnreservedBandwidthBuilder
withKey(UnreservedBandwidthKey key)
-
-
-
Constructor Detail
-
UnreservedBandwidthBuilder
public UnreservedBandwidthBuilder()
-
UnreservedBandwidthBuilder
public UnreservedBandwidthBuilder(UnreservedBandwidth base)
-
-
Method Detail
-
key
public UnreservedBandwidthKey key()
-
getBandwidth
public BigDecimal getBandwidth()
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint8 getPriority()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreservedBandwidth>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public UnreservedBandwidthBuilder withKey(UnreservedBandwidthKey key)
-
setBandwidth
public UnreservedBandwidthBuilder setBandwidth(BigDecimal value)
-
setPriority
public UnreservedBandwidthBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setPriority
@Deprecated(forRemoval=true) public UnreservedBandwidthBuilder setPriority(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPriority(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- 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 UnreservedBandwidth build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<UnreservedBandwidth>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<UnreservedBandwidth,IllegalArgumentException>
-
-