Class BgpNeighborsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.BgpNeighborsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BgpNeighbors>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BgpNeighbors,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BgpNeighborsBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<BgpNeighbors>
Class that buildsBgpNeighborsBuilder
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:
BgpNeighborsBuilder createTarget(int fooXyzzy, int barBaz) { return new BgpNeighborsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BgpNeighborsBuilder, 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:
BgpNeighborsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BgpNeighborsBuilder()
BgpNeighborsBuilder(BgpNeighbors base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BgpNeighborsBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighbors>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighbors> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighbors>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
BgpNeighbors
build()
java.util.List<BgpNeighbor>
getBgpNeighbor()
BgpNeighborsBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighbors>> augmentationType)
BgpNeighborsBuilder
setBgpNeighbor(java.util.List<BgpNeighbor> values)
-
-
-
Constructor Detail
-
BgpNeighborsBuilder
public BgpNeighborsBuilder()
-
BgpNeighborsBuilder
public BgpNeighborsBuilder(BgpNeighbors base)
-
-
Method Detail
-
getBgpNeighbor
public java.util.List<BgpNeighbor> getBgpNeighbor()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighbors>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setBgpNeighbor
public BgpNeighborsBuilder setBgpNeighbor(java.util.List<BgpNeighbor> values)
-
addAugmentation
public BgpNeighborsBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighbors>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighbors> augmentationValue)
-
removeAugmentation
public BgpNeighborsBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighbors>> augmentationType)
-
build
public BgpNeighbors build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BgpNeighbors>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BgpNeighbors,java.lang.IllegalArgumentException>
-
-