Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.tunnelnexthops
Class TunnelNexthopBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.tunnelnexthops.TunnelNexthopBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TunnelNexthop>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TunnelNexthop,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TunnelNexthopBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<TunnelNexthop>
Class that buildsTunnelNexthopBuilder
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:
TunnelNexthopBuilder createTarget(int fooXyzzy, int barBaz) { return new TunnelNexthopBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TunnelNexthopBuilder, 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:
TunnelNexthopBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TunnelNexthopBuilder()
TunnelNexthopBuilder(TunnelNexthop base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TunnelNexthopBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunnelNexthop> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelNexthop>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
TunnelNexthop
build()
org.opendaylight.yangtools.yang.common.Uint32
getEgressPointer()
java.lang.String
getIpAddress()
TunnelNexthopKey
key()
TunnelNexthopBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelNexthop>> augmentationType)
Remove an augmentation from this builder's product.TunnelNexthopBuilder
setEgressPointer(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEgressPointer(Uint32)
instead.TunnelNexthopBuilder
setEgressPointer(org.opendaylight.yangtools.yang.common.Uint32 value)
TunnelNexthopBuilder
setIpAddress(java.lang.String value)
TunnelNexthopBuilder
withKey(TunnelNexthopKey key)
-
-
-
Constructor Detail
-
TunnelNexthopBuilder
public TunnelNexthopBuilder()
-
TunnelNexthopBuilder
public TunnelNexthopBuilder(TunnelNexthop base)
-
-
Method Detail
-
key
public TunnelNexthopKey key()
-
getEgressPointer
public org.opendaylight.yangtools.yang.common.Uint32 getEgressPointer()
-
getIpAddress
public java.lang.String getIpAddress()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelNexthop>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public TunnelNexthopBuilder withKey(TunnelNexthopKey key)
-
setEgressPointer
public TunnelNexthopBuilder setEgressPointer(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setEgressPointer
@Deprecated(forRemoval=true) public TunnelNexthopBuilder 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 TunnelNexthopBuilder setIpAddress(java.lang.String value)
-
addAugmentation
public TunnelNexthopBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunnelNexthop> 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 TunnelNexthopBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelNexthop>> 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 TunnelNexthop build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TunnelNexthop>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TunnelNexthop,java.lang.IllegalArgumentException>
-
-