Class BgpStateConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.state.config.rev161107.BgpStateConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BgpStateConfig>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BgpStateConfig,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BgpStateConfigBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BgpStateConfig>
Class that buildsBgpStateConfigBuilder
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:
BgpStateConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new BgpStateConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BgpStateConfigBuilder, 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:
BgpStateConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BgpStateConfigBuilder()
BgpStateConfigBuilder(BgpStateConfig base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BgpStateConfigBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpStateConfig>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BgpStateConfig> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpStateConfig>>
E$$augmentation(Class<E$$> augmentationType)
BgpStateConfig
build()
String
getConfigName()
org.opendaylight.yangtools.yang.common.Uint16
getTimer()
BgpStateConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpStateConfig>> augmentationType)
BgpStateConfigBuilder
setConfigName(String value)
BgpStateConfigBuilder
setTimer(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setTimer(Uint16)} instead.BgpStateConfigBuilder
setTimer(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
BgpStateConfigBuilder
public BgpStateConfigBuilder()
-
BgpStateConfigBuilder
public BgpStateConfigBuilder(BgpStateConfig base)
-
-
Method Detail
-
getConfigName
public String getConfigName()
-
getTimer
public org.opendaylight.yangtools.yang.common.Uint16 getTimer()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpStateConfig>> E$$ augmentation(Class<E$$> augmentationType)
-
setConfigName
public BgpStateConfigBuilder setConfigName(String value)
-
setTimer
public BgpStateConfigBuilder setTimer(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setTimer
@Deprecated(forRemoval=true) public BgpStateConfigBuilder setTimer(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setTimer(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public BgpStateConfigBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpStateConfig>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BgpStateConfig> augmentationValue)
-
removeAugmentation
public BgpStateConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpStateConfig>> augmentationType)
-
build
public BgpStateConfig build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BgpStateConfig>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BgpStateConfig,IllegalArgumentException>
-
-