Class TunnelIpsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical._switch.attributes.TunnelIpsBuilder
-
@Generated("mdsal-binding-generator") public class TunnelIpsBuilder extends Object
Class that buildsTunnelIps
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:
TunnelIps createTunnelIps(int fooXyzzy, int barBaz) { return new TunnelIpsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TunnelIps, 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 opportunities, 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:
TunnelIps
- 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
-
-
Constructor Summary
Constructors Constructor Description TunnelIpsBuilder()
Construct an empty builder.TunnelIpsBuilder(TunnelIps base)
Construct a builder initialized with state from specifiedTunnelIps
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TunnelIpsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunnelIps> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelIps>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull TunnelIps
build()
A newTunnelIps
instance.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getTunnelIpsKey()
Return current value associated with the property corresponding toTunnelIps.getTunnelIpsKey()
.TunnelIpsKey
key()
Return current value associated with the property corresponding toTunnelIps.key()
.TunnelIpsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelIps>> augmentationType)
Remove an augmentation from this builder's product.TunnelIpsBuilder
setTunnelIpsKey(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
Set the property corresponding toTunnelIps.getTunnelIpsKey()
to the specified value.TunnelIpsBuilder
withKey(TunnelIpsKey key)
-
-
-
Method Detail
-
key
public TunnelIpsKey key()
Return current value associated with the property corresponding toTunnelIps.key()
.- Returns:
- current value
-
getTunnelIpsKey
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getTunnelIpsKey()
Return current value associated with the property corresponding toTunnelIps.getTunnelIpsKey()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelIps>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
public TunnelIpsBuilder withKey(TunnelIpsKey key)
-
setTunnelIpsKey
public TunnelIpsBuilder setTunnelIpsKey(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
Set the property corresponding toTunnelIps.getTunnelIpsKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TunnelIpsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunnelIps> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public TunnelIpsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelIps>> 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
-
-