Class OfDpnTepBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.tep.config.OfDpnTepBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<OfDpnTep>
,org.opendaylight.yangtools.concepts.CheckedBuilder<OfDpnTep,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class OfDpnTepBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<OfDpnTep>
Class that buildsOfDpnTepBuilder
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:
OfDpnTepBuilder createTarget(int fooXyzzy, int barBaz) { return new OfDpnTepBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OfDpnTepBuilder, 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:
OfDpnTepBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OfDpnTepBuilder()
OfDpnTepBuilder(OfDpnTep base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OfDpnTepBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OfDpnTep> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OfDpnTep>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
OfDpnTep
build()
java.lang.String
getOfPortName()
org.opendaylight.yangtools.yang.common.Uint64
getSourceDpnId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getTepIp()
java.lang.Class<? extends TunnelTypeBase>
getTunnelType()
OfDpnTepKey
key()
OfDpnTepBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OfDpnTep>> augmentationType)
Remove an augmentation from this builder's product.OfDpnTepBuilder
setOfPortName(java.lang.String value)
OfDpnTepBuilder
setSourceDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSourceDpnId(Uint64)
instead.OfDpnTepBuilder
setSourceDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
OfDpnTepBuilder
setTepIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
OfDpnTepBuilder
setTunnelType(java.lang.Class<? extends TunnelTypeBase> value)
OfDpnTepBuilder
withKey(OfDpnTepKey key)
-
-
-
Constructor Detail
-
OfDpnTepBuilder
public OfDpnTepBuilder()
-
OfDpnTepBuilder
public OfDpnTepBuilder(OfDpnTep base)
-
-
Method Detail
-
key
public OfDpnTepKey key()
-
getOfPortName
public java.lang.String getOfPortName()
-
getSourceDpnId
public org.opendaylight.yangtools.yang.common.Uint64 getSourceDpnId()
-
getTepIp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getTepIp()
-
getTunnelType
public java.lang.Class<? extends TunnelTypeBase> getTunnelType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OfDpnTep>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public OfDpnTepBuilder withKey(OfDpnTepKey key)
-
setOfPortName
public OfDpnTepBuilder setOfPortName(java.lang.String value)
-
setSourceDpnId
public OfDpnTepBuilder setSourceDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setSourceDpnId
@Deprecated(forRemoval=true) public OfDpnTepBuilder 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
-
setTepIp
public OfDpnTepBuilder setTepIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setTunnelType
public OfDpnTepBuilder setTunnelType(java.lang.Class<? extends TunnelTypeBase> value)
-
addAugmentation
public OfDpnTepBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OfDpnTep> 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 OfDpnTepBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OfDpnTep>> 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
-
-