Class PcepAutoBandwidthAppConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.auto.bandwidth.app.config.rev160707.PcepAutoBandwidthAppConfigBuilder
-
@Generated("mdsal-binding-generator") public class PcepAutoBandwidthAppConfigBuilder extends Object
Class that buildsPcepAutoBandwidthAppConfig
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:
PcepAutoBandwidthAppConfig createPcepAutoBandwidthAppConfig(int fooXyzzy, int barBaz) { return new PcepAutoBandwidthAppConfigBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PcepAutoBandwidthAppConfig, 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:
PcepAutoBandwidthAppConfig
- 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 PcepAutoBandwidthAppConfigBuilder()
Construct an empty builder.PcepAutoBandwidthAppConfigBuilder(PcepAutoBandwidthAppConfig base)
Construct a builder initialized with state from specifiedPcepAutoBandwidthAppConfig
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PcepAutoBandwidthAppConfigBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcepAutoBandwidthAppConfig> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepAutoBandwidthAppConfig>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PcepAutoBandwidthAppConfig
build()
A newPcepAutoBandwidthAppConfig
instance.org.opendaylight.yangtools.yang.common.Uint16
getBandwidthUsageObjectType()
Return current value associated with the property corresponding toPcepAutoBandwidthAppConfig.getBandwidthUsageObjectType()
.PcepAutoBandwidthAppConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepAutoBandwidthAppConfig>> augmentationType)
Remove an augmentation from this builder's product.PcepAutoBandwidthAppConfigBuilder
setBandwidthUsageObjectType(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toPcepAutoBandwidthAppConfig.getBandwidthUsageObjectType()
to the specified value.
-
-
-
Constructor Detail
-
PcepAutoBandwidthAppConfigBuilder
public PcepAutoBandwidthAppConfigBuilder()
Construct an empty builder.
-
PcepAutoBandwidthAppConfigBuilder
public PcepAutoBandwidthAppConfigBuilder(PcepAutoBandwidthAppConfig base)
Construct a builder initialized with state from specifiedPcepAutoBandwidthAppConfig
.- Parameters:
base
- PcepAutoBandwidthAppConfig from which the builder should be initialized
-
-
Method Detail
-
getBandwidthUsageObjectType
public org.opendaylight.yangtools.yang.common.Uint16 getBandwidthUsageObjectType()
Return current value associated with the property corresponding toPcepAutoBandwidthAppConfig.getBandwidthUsageObjectType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepAutoBandwidthAppConfig>> 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
-
setBandwidthUsageObjectType
public PcepAutoBandwidthAppConfigBuilder setBandwidthUsageObjectType(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toPcepAutoBandwidthAppConfig.getBandwidthUsageObjectType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PcepAutoBandwidthAppConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcepAutoBandwidthAppConfig> 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 PcepAutoBandwidthAppConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepAutoBandwidthAppConfig>> 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 PcepAutoBandwidthAppConfig build()
A newPcepAutoBandwidthAppConfig
instance.- Returns:
- A new
PcepAutoBandwidthAppConfig
instance.
-
-