Class AutoConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv4.unicast.bgp.router.id.config.type.AutoConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AutoConfig>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AutoConfig,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AutoConfigBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<AutoConfig>
Class that buildsAutoConfigBuilder
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:
AutoConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new AutoConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AutoConfigBuilder, 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:
AutoConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AutoConfigBuilder()
AutoConfigBuilder(AutoConfig base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AutoConfigBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AutoConfig> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AutoConfig>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
AutoConfig
build()
java.lang.Boolean
getEnableAutoConfig()
java.lang.Boolean
isEnableAutoConfig()
Deprecated, for removal: This API element is subject to removal in a future version.AutoConfigBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AutoConfig>> augmentationType)
Remove an augmentation from this builder's product.AutoConfigBuilder
setEnableAutoConfig(java.lang.Boolean value)
-
-
-
Constructor Detail
-
AutoConfigBuilder
public AutoConfigBuilder()
-
AutoConfigBuilder
public AutoConfigBuilder(AutoConfig base)
-
-
Method Detail
-
getEnableAutoConfig
public java.lang.Boolean getEnableAutoConfig()
-
isEnableAutoConfig
@Deprecated(forRemoval=true) public final java.lang.Boolean isEnableAutoConfig()
Deprecated, for removal: This API element is subject to removal in a future version.
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AutoConfig>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setEnableAutoConfig
public AutoConfigBuilder setEnableAutoConfig(java.lang.Boolean value)
-
addAugmentation
public AutoConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AutoConfig> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public AutoConfigBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AutoConfig>> 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 AutoConfig build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AutoConfig>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AutoConfig,java.lang.IllegalArgumentException>
-
-