Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone
Class VtepsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.VtepsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Vteps>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Vteps,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VtepsBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Vteps>
Class that buildsVtepsBuilder
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:
VtepsBuilder createTarget(int fooXyzzy, int barBaz) { return new VtepsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VtepsBuilder, 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:
VtepsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VtepsBuilder()
VtepsBuilder(Vteps base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VtepsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Vteps> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Vteps>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Vteps
build()
org.opendaylight.yangtools.yang.common.Uint64
getDpnId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getIpAddress()
java.lang.Boolean
getOptionOfTunnel()
java.lang.String
getOptionTunnelTos()
java.lang.Boolean
isOptionOfTunnel()
Deprecated, for removal: This API element is subject to removal in a future version.VtepsKey
key()
VtepsBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vteps>> augmentationType)
Remove an augmentation from this builder's product.VtepsBuilder
setDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpnId(Uint64)
instead.VtepsBuilder
setDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
VtepsBuilder
setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
VtepsBuilder
setOptionOfTunnel(java.lang.Boolean value)
VtepsBuilder
setOptionTunnelTos(java.lang.String value)
VtepsBuilder
withKey(VtepsKey key)
-
-
-
Constructor Detail
-
VtepsBuilder
public VtepsBuilder()
-
VtepsBuilder
public VtepsBuilder(Vteps base)
-
-
Method Detail
-
key
public VtepsKey key()
-
getDpnId
public org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
-
getIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpAddress()
-
getOptionOfTunnel
public java.lang.Boolean getOptionOfTunnel()
-
isOptionOfTunnel
@Deprecated(forRemoval=true) public final java.lang.Boolean isOptionOfTunnel()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getOptionTunnelTos
public java.lang.String getOptionTunnelTos()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Vteps>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VtepsBuilder withKey(VtepsKey key)
-
setDpnId
public VtepsBuilder setDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDpnId
@Deprecated(forRemoval=true) public VtepsBuilder 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
-
setIpAddress
public VtepsBuilder setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setOptionOfTunnel
public VtepsBuilder setOptionOfTunnel(java.lang.Boolean value)
-
setOptionTunnelTos
public VtepsBuilder setOptionTunnelTos(java.lang.String value)
-
addAugmentation
public VtepsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Vteps> 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 VtepsBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vteps>> 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
-
-