Package org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.vrfscontainer.vrfs
Class AddressFamiliesVrfBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.vrfscontainer.vrfs.AddressFamiliesVrfBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AddressFamiliesVrf>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AddressFamiliesVrf,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class AddressFamiliesVrfBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<AddressFamiliesVrf>
Class that buildsAddressFamiliesVrfBuilder
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:
AddressFamiliesVrfBuilder createTarget(int fooXyzzy, int barBaz) { return new AddressFamiliesVrfBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AddressFamiliesVrfBuilder, 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:
AddressFamiliesVrfBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AddressFamiliesVrfBuilder()
AddressFamiliesVrfBuilder(AddressFamiliesVrf base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AddressFamiliesVrfBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamiliesVrf>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamiliesVrf> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamiliesVrf>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
AddressFamiliesVrf
build()
org.opendaylight.yangtools.yang.common.Uint32
getAfi()
org.opendaylight.yangtools.yang.common.Uint32
getSafi()
AddressFamiliesVrfKey
key()
AddressFamiliesVrfBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamiliesVrf>> augmentationType)
AddressFamiliesVrfBuilder
setAfi(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setAfi(Uint32)} instead.AddressFamiliesVrfBuilder
setAfi(org.opendaylight.yangtools.yang.common.Uint32 value)
AddressFamiliesVrfBuilder
setSafi(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSafi(Uint32)} instead.AddressFamiliesVrfBuilder
setSafi(org.opendaylight.yangtools.yang.common.Uint32 value)
AddressFamiliesVrfBuilder
withKey(AddressFamiliesVrfKey key)
-
-
-
Constructor Detail
-
AddressFamiliesVrfBuilder
public AddressFamiliesVrfBuilder()
-
AddressFamiliesVrfBuilder
public AddressFamiliesVrfBuilder(AddressFamiliesVrf base)
-
-
Method Detail
-
key
public AddressFamiliesVrfKey key()
-
getAfi
public org.opendaylight.yangtools.yang.common.Uint32 getAfi()
-
getSafi
public org.opendaylight.yangtools.yang.common.Uint32 getSafi()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamiliesVrf>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public AddressFamiliesVrfBuilder withKey(AddressFamiliesVrfKey key)
-
setAfi
public AddressFamiliesVrfBuilder setAfi(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setAfi
@Deprecated(forRemoval=true) public AddressFamiliesVrfBuilder 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
-
setSafi
public AddressFamiliesVrfBuilder setSafi(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSafi
@Deprecated(forRemoval=true) public AddressFamiliesVrfBuilder 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 AddressFamiliesVrfBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamiliesVrf>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamiliesVrf> augmentationValue)
-
removeAugmentation
public AddressFamiliesVrfBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamiliesVrf>> augmentationType)
-
build
public AddressFamiliesVrf build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AddressFamiliesVrf>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AddressFamiliesVrf,java.lang.IllegalArgumentException>
-
-