Class AsPathBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.af.config.bestpath.bestpath.selection.AsPathBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AsPath>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AsPath,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class AsPathBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<AsPath>
Class that buildsAsPathBuilder
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:
AsPathBuilder createTarget(int fooXyzzy, int barBaz) { return new AsPathBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AsPathBuilder, 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:
AsPathBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AsPathBuilder()
AsPathBuilder(AsPath base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AsPathBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPath>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AsPath> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPath>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
AsPath
build()
java.lang.Boolean
isIgnoreAsPath()
AsPathBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPath>> augmentationType)
AsPathBuilder
setIgnoreAsPath(java.lang.Boolean value)
-
-
-
Constructor Detail
-
AsPathBuilder
public AsPathBuilder()
-
AsPathBuilder
public AsPathBuilder(AsPath base)
-
-
Method Detail
-
isIgnoreAsPath
public java.lang.Boolean isIgnoreAsPath()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPath>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setIgnoreAsPath
public AsPathBuilder setIgnoreAsPath(java.lang.Boolean value)
-
addAugmentation
public AsPathBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPath>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AsPath> augmentationValue)
-
removeAugmentation
public AsPathBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsPath>> augmentationType)
-
-