Class EbgpMultihopBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.neighborscontainer.neighbors.EbgpMultihopBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<EbgpMultihop>
,org.opendaylight.yangtools.concepts.CheckedBuilder<EbgpMultihop,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class EbgpMultihopBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<EbgpMultihop>
Class that buildsEbgpMultihopBuilder
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:
EbgpMultihopBuilder createTarget(int fooXyzzy, int barBaz) { return new EbgpMultihopBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EbgpMultihopBuilder, 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:
EbgpMultihopBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description EbgpMultihopBuilder()
EbgpMultihopBuilder(EbgpMultihop base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description EbgpMultihopBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EbgpMultihop>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<EbgpMultihop> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EbgpMultihop>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
EbgpMultihop
build()
org.opendaylight.yangtools.yang.common.Uint32
getNhops()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address
getPeerIp()
EbgpMultihopBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EbgpMultihop>> augmentationType)
EbgpMultihopBuilder
setNhops(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setNhops(Uint32)} instead.EbgpMultihopBuilder
setNhops(org.opendaylight.yangtools.yang.common.Uint32 value)
EbgpMultihopBuilder
setPeerIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
-
-
-
Constructor Detail
-
EbgpMultihopBuilder
public EbgpMultihopBuilder()
-
EbgpMultihopBuilder
public EbgpMultihopBuilder(EbgpMultihop base)
-
-
Method Detail
-
getNhops
public org.opendaylight.yangtools.yang.common.Uint32 getNhops()
-
getPeerIp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getPeerIp()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EbgpMultihop>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setNhops
public EbgpMultihopBuilder setNhops(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setNhops
@Deprecated(forRemoval=true) public EbgpMultihopBuilder setNhops(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setNhops(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPeerIp
public EbgpMultihopBuilder setPeerIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
-
addAugmentation
public EbgpMultihopBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EbgpMultihop>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<EbgpMultihop> augmentationValue)
-
removeAugmentation
public EbgpMultihopBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EbgpMultihop>> augmentationType)
-
build
public EbgpMultihop build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<EbgpMultihop>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<EbgpMultihop,java.lang.IllegalArgumentException>
-
-