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