Class AsPathOptionsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AsPathOptionsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AsPathOptions>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AsPathOptions,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class AsPathOptionsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<AsPathOptions>
Class that buildsAsPathOptionsBuilder
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:
AsPathOptionsBuilder createTarget(int fooXyzzy, int barBaz) { return new AsPathOptionsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AsPathOptionsBuilder, 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:
AsPathOptionsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AsPathOptionsBuilder()
AsPathOptionsBuilder(AsPathOptions base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AsPathOptionsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPathOptions>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AsPathOptions> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPathOptions>>
E$$augmentation(Class<E$$> augmentationType)
AsPathOptions
build()
Config
getConfig()
State
getState()
AsPathOptionsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPathOptions>> augmentationType)
AsPathOptionsBuilder
setConfig(Config value)
AsPathOptionsBuilder
setState(State value)
-
-
-
Constructor Detail
-
AsPathOptionsBuilder
public AsPathOptionsBuilder()
-
AsPathOptionsBuilder
public AsPathOptionsBuilder(AsPathOptions base)
-
-
Method Detail
-
getConfig
public Config getConfig()
-
getState
public State getState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPathOptions>> E$$ augmentation(Class<E$$> augmentationType)
-
setConfig
public AsPathOptionsBuilder setConfig(Config value)
-
setState
public AsPathOptionsBuilder setState(State value)
-
addAugmentation
public AsPathOptionsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPathOptions>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AsPathOptions> augmentationValue)
-
removeAugmentation
public AsPathOptionsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPathOptions>> augmentationType)
-
build
public AsPathOptions build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AsPathOptions>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AsPathOptions,IllegalArgumentException>
-
-