Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.vpnnexthops
Class VpnNexthopBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.vpnnexthops.VpnNexthopBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnNexthop>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnNexthop,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VpnNexthopBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VpnNexthop>
Class that buildsVpnNexthopBuilder
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:
VpnNexthopBuilder createTarget(int fooXyzzy, int barBaz) { return new VpnNexthopBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnNexthopBuilder, 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:
VpnNexthopBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnNexthopBuilder()
VpnNexthopBuilder(VpnNexthop base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VpnNexthopBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthop> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthop>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VpnNexthop
build()
org.opendaylight.yangtools.yang.common.Uint64
getDpnId()
org.opendaylight.yangtools.yang.common.Uint32
getEgressPointer()
java.lang.String
getIpAddress()
java.util.Map<IpAdjacenciesKey,IpAdjacencies>
getIpAdjacencies()
VpnNexthopKey
key()
VpnNexthopBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthop>> augmentationType)
Remove an augmentation from this builder's product.VpnNexthopBuilder
setDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpnId(Uint64)
instead.VpnNexthopBuilder
setDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
VpnNexthopBuilder
setEgressPointer(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEgressPointer(Uint32)
instead.VpnNexthopBuilder
setEgressPointer(org.opendaylight.yangtools.yang.common.Uint32 value)
VpnNexthopBuilder
setIpAddress(java.lang.String value)
VpnNexthopBuilder
setIpAdjacencies(java.util.List<IpAdjacencies> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpAdjacencies(Map)
instead.VpnNexthopBuilder
setIpAdjacencies(java.util.Map<IpAdjacenciesKey,IpAdjacencies> values)
VpnNexthopBuilder
withKey(VpnNexthopKey key)
-
-
-
Constructor Detail
-
VpnNexthopBuilder
public VpnNexthopBuilder()
-
VpnNexthopBuilder
public VpnNexthopBuilder(VpnNexthop base)
-
-
Method Detail
-
key
public VpnNexthopKey key()
-
getDpnId
public org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
-
getEgressPointer
public org.opendaylight.yangtools.yang.common.Uint32 getEgressPointer()
-
getIpAddress
public java.lang.String getIpAddress()
-
getIpAdjacencies
public java.util.Map<IpAdjacenciesKey,IpAdjacencies> getIpAdjacencies()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthop>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VpnNexthopBuilder withKey(VpnNexthopKey key)
-
setDpnId
public VpnNexthopBuilder setDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDpnId
@Deprecated(forRemoval=true) public VpnNexthopBuilder setDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpnId(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setEgressPointer
public VpnNexthopBuilder setEgressPointer(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setEgressPointer
@Deprecated(forRemoval=true) public VpnNexthopBuilder setEgressPointer(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEgressPointer(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setIpAddress
public VpnNexthopBuilder setIpAddress(java.lang.String value)
-
setIpAdjacencies
public VpnNexthopBuilder setIpAdjacencies(java.util.Map<IpAdjacenciesKey,IpAdjacencies> values)
-
setIpAdjacencies
@Deprecated(forRemoval=true) public VpnNexthopBuilder setIpAdjacencies(java.util.List<IpAdjacencies> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpAdjacencies(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
java.lang.IllegalArgumentException
- if the list contains entries with the same keyjava.lang.NullPointerException
- if the list contains a null entry
-
addAugmentation
public VpnNexthopBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthop> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public VpnNexthopBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthop>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
public VpnNexthop build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VpnNexthop>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VpnNexthop,java.lang.IllegalArgumentException>
-
-