Package org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.neighborscontainer
Class NeighborsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.neighborscontainer.NeighborsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Neighbors>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Neighbors,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class NeighborsBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Neighbors>
Class that buildsNeighborsBuilder
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:
NeighborsBuilder createTarget(int fooXyzzy, int barBaz) { return new NeighborsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NeighborsBuilder, 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:
NeighborsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NeighborsBuilder()
NeighborsBuilder(Neighbors base)
NeighborsBuilder(TcpSecurityOptionGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NeighborsBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Neighbors>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Neighbors> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Neighbors>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Neighbors
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address
getAddress()
java.util.List<AddressFamilies>
getAddressFamilies()
EbgpMultihop
getEbgpMultihop()
org.opendaylight.yangtools.yang.common.Uint32
getRemoteAs()
TcpSecurityOption
getTcpSecurityOption()
UpdateSource
getUpdateSource()
NeighborsKey
key()
NeighborsBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Neighbors>> augmentationType)
NeighborsBuilder
setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
NeighborsBuilder
setAddressFamilies(java.util.List<AddressFamilies> values)
NeighborsBuilder
setEbgpMultihop(EbgpMultihop value)
NeighborsBuilder
setRemoteAs(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setRemoteAs(Uint32)} instead.NeighborsBuilder
setRemoteAs(org.opendaylight.yangtools.yang.common.Uint32 value)
NeighborsBuilder
setTcpSecurityOption(TcpSecurityOption value)
NeighborsBuilder
setUpdateSource(UpdateSource value)
NeighborsBuilder
withKey(NeighborsKey key)
-
-
-
Constructor Detail
-
NeighborsBuilder
public NeighborsBuilder()
-
NeighborsBuilder
public NeighborsBuilder(TcpSecurityOptionGrouping arg)
-
NeighborsBuilder
public NeighborsBuilder(Neighbors base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.TcpSecurityOptionGrouping
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
key
public NeighborsKey key()
-
getAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getAddress()
-
getAddressFamilies
public java.util.List<AddressFamilies> getAddressFamilies()
-
getEbgpMultihop
public EbgpMultihop getEbgpMultihop()
-
getRemoteAs
public org.opendaylight.yangtools.yang.common.Uint32 getRemoteAs()
-
getTcpSecurityOption
public TcpSecurityOption getTcpSecurityOption()
-
getUpdateSource
public UpdateSource getUpdateSource()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Neighbors>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public NeighborsBuilder withKey(NeighborsKey key)
-
setAddress
public NeighborsBuilder setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
-
setAddressFamilies
public NeighborsBuilder setAddressFamilies(java.util.List<AddressFamilies> values)
-
setEbgpMultihop
public NeighborsBuilder setEbgpMultihop(EbgpMultihop value)
-
setRemoteAs
public NeighborsBuilder setRemoteAs(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setRemoteAs
@Deprecated(forRemoval=true) public NeighborsBuilder setRemoteAs(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setRemoteAs(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTcpSecurityOption
public NeighborsBuilder setTcpSecurityOption(TcpSecurityOption value)
-
setUpdateSource
public NeighborsBuilder setUpdateSource(UpdateSource value)
-
addAugmentation
public NeighborsBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Neighbors>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Neighbors> augmentationValue)
-
removeAugmentation
public NeighborsBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Neighbors>> augmentationType)
-
-