Class DpnsTepsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.teps.state.DpnsTepsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<DpnsTeps>
,org.opendaylight.yangtools.concepts.CheckedBuilder<DpnsTeps,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class DpnsTepsBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<DpnsTeps>
Class that buildsDpnsTepsBuilder
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:
DpnsTepsBuilder createTarget(int fooXyzzy, int barBaz) { return new DpnsTepsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DpnsTepsBuilder, 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:
DpnsTepsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description DpnsTepsBuilder()
DpnsTepsBuilder(DpnsTeps base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DpnsTepsBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DpnsTeps>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DpnsTeps> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.DpnsTepsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DpnsTeps> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DpnsTeps>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
DpnsTeps
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getIpAddress()
java.lang.String
getOfTunnel()
java.util.Map<RemoteDpnsKey,RemoteDpns>
getRemoteDpns()
org.opendaylight.yangtools.yang.common.Uint64
getSourceDpnId()
java.lang.Class<? extends TunnelTypeBase>
getTunnelType()
DpnsTepsKey
key()
DpnsTepsBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DpnsTeps>> augmentationType)
Remove an augmentation from this builder's product.DpnsTepsBuilder
setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
DpnsTepsBuilder
setOfTunnel(java.lang.String value)
DpnsTepsBuilder
setRemoteDpns(java.util.List<RemoteDpns> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRemoteDpns(Map)
instead.DpnsTepsBuilder
setRemoteDpns(java.util.Map<RemoteDpnsKey,RemoteDpns> values)
DpnsTepsBuilder
setSourceDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSourceDpnId(Uint64)
instead.DpnsTepsBuilder
setSourceDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
DpnsTepsBuilder
setTunnelType(java.lang.Class<? extends TunnelTypeBase> value)
DpnsTepsBuilder
withKey(DpnsTepsKey key)
-
-
-
Constructor Detail
-
DpnsTepsBuilder
public DpnsTepsBuilder()
-
DpnsTepsBuilder
public DpnsTepsBuilder(DpnsTeps base)
-
-
Method Detail
-
key
public DpnsTepsKey key()
-
getIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpAddress()
-
getOfTunnel
public java.lang.String getOfTunnel()
-
getRemoteDpns
public java.util.Map<RemoteDpnsKey,RemoteDpns> getRemoteDpns()
-
getSourceDpnId
public org.opendaylight.yangtools.yang.common.Uint64 getSourceDpnId()
-
getTunnelType
public java.lang.Class<? extends TunnelTypeBase> getTunnelType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DpnsTeps>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public DpnsTepsBuilder withKey(DpnsTepsKey key)
-
setIpAddress
public DpnsTepsBuilder setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setOfTunnel
public DpnsTepsBuilder setOfTunnel(java.lang.String value)
-
setRemoteDpns
public DpnsTepsBuilder setRemoteDpns(java.util.Map<RemoteDpnsKey,RemoteDpns> values)
-
setRemoteDpns
@Deprecated(forRemoval=true) public DpnsTepsBuilder setRemoteDpns(java.util.List<RemoteDpns> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRemoteDpns(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
-
setSourceDpnId
public DpnsTepsBuilder setSourceDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setSourceDpnId
@Deprecated(forRemoval=true) public DpnsTepsBuilder setSourceDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSourceDpnId(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTunnelType
public DpnsTepsBuilder setTunnelType(java.lang.Class<? extends TunnelTypeBase> value)
-
addAugmentation
public DpnsTepsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DpnsTeps> 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
-
addAugmentation
@Deprecated(forRemoval=true) public DpnsTepsBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DpnsTeps>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DpnsTeps> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public DpnsTepsBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DpnsTeps>> 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
-
-