Class OfTepBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.of.teps.state.OfTepBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<OfTep>
,org.opendaylight.yangtools.concepts.CheckedBuilder<OfTep,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class OfTepBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<OfTep>
Class that buildsOfTepBuilder
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:
OfTepBuilder createTarget(int fooXyzzy, int barBaz) { return new OfTepBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OfTepBuilder, 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:
OfTepBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OfTepBuilder()
OfTepBuilder(OfTep base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OfTepBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OfTep> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OfTep>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
OfTep
build()
org.opendaylight.yangtools.yang.common.Uint16
getIfIndex()
java.lang.String
getOfPortName()
TunnelOperStatus
getOfTepState()
java.lang.String
getPortNumber()
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()
OfTepKey
key()
OfTepBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OfTep>> augmentationType)
Remove an augmentation from this builder's product.OfTepBuilder
setIfIndex(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIfIndex(Uint16)
instead.OfTepBuilder
setIfIndex(org.opendaylight.yangtools.yang.common.Uint16 value)
OfTepBuilder
setOfPortName(java.lang.String value)
OfTepBuilder
setOfTepState(TunnelOperStatus value)
OfTepBuilder
setPortNumber(java.lang.String value)
OfTepBuilder
setSourceDpnId(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSourceDpnId(Uint64)
instead.OfTepBuilder
setSourceDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
OfTepBuilder
setTepIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
OfTepBuilder
setTunnelType(java.lang.Class<? extends TunnelTypeBase> value)
OfTepBuilder
withKey(OfTepKey key)
-
-
-
Constructor Detail
-
OfTepBuilder
public OfTepBuilder()
-
OfTepBuilder
public OfTepBuilder(OfTep base)
-
-
Method Detail
-
key
public OfTepKey key()
-
getIfIndex
public org.opendaylight.yangtools.yang.common.Uint16 getIfIndex()
-
getOfPortName
public java.lang.String getOfPortName()
-
getOfTepState
public TunnelOperStatus getOfTepState()
-
getPortNumber
public java.lang.String getPortNumber()
-
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<OfTep>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public OfTepBuilder withKey(OfTepKey key)
-
setIfIndex
public OfTepBuilder setIfIndex(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIfIndex
@Deprecated(forRemoval=true) public OfTepBuilder setIfIndex(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIfIndex(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setOfPortName
public OfTepBuilder setOfPortName(java.lang.String value)
-
setOfTepState
public OfTepBuilder setOfTepState(TunnelOperStatus value)
-
setPortNumber
public OfTepBuilder setPortNumber(java.lang.String value)
-
setSourceDpnId
public OfTepBuilder setSourceDpnId(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setSourceDpnId
@Deprecated(forRemoval=true) public OfTepBuilder 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 OfTepBuilder setTepIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setTunnelType
public OfTepBuilder setTunnelType(java.lang.Class<? extends TunnelTypeBase> value)
-
addAugmentation
public OfTepBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OfTep> 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 OfTepBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OfTep>> 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
-
-