Class TunnelsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical._switch.attributes.TunnelsBuilder
-
@Generated("mdsal-binding-generator") public class TunnelsBuilder extends Object
Class that buildsTunnels
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:
Tunnels createTunnels(int fooXyzzy, int barBaz) { return new TunnelsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Tunnels, 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:
Tunnels
- 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 TunnelsBuilder()
Construct an empty builder.TunnelsBuilder(Tunnels base)
Construct a builder initialized with state from specifiedTunnels
.TunnelsBuilder(HwvtepTunnelAttributes arg)
Construct a new builder initialized from specifiedHwvtepTunnelAttributes
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TunnelsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Tunnels> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tunnels>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Tunnels
build()
A newTunnels
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<BfdLocalConfigsKey,BfdLocalConfigs>
getBfdLocalConfigs()
Return current value associated with the property corresponding toHwvtepTunnelAttributes.getBfdLocalConfigs()
.Map<BfdParamsKey,BfdParams>
getBfdParams()
Return current value associated with the property corresponding toHwvtepTunnelAttributes.getBfdParams()
.Map<BfdRemoteConfigsKey,BfdRemoteConfigs>
getBfdRemoteConfigs()
Return current value associated with the property corresponding toHwvtepTunnelAttributes.getBfdRemoteConfigs()
.Map<BfdStatusKey,BfdStatus>
getBfdStatus()
Return current value associated with the property corresponding toHwvtepTunnelAttributes.getBfdStatus()
.HwvtepPhysicalLocatorRef
getLocalLocatorRef()
Return current value associated with the property corresponding toHwvtepTunnelAttributes.getLocalLocatorRef()
.HwvtepPhysicalLocatorRef
getRemoteLocatorRef()
Return current value associated with the property corresponding toHwvtepTunnelAttributes.getRemoteLocatorRef()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getTunnelUuid()
Return current value associated with the property corresponding toHwvtepTunnelAttributes.getTunnelUuid()
.TunnelsKey
key()
Return current value associated with the property corresponding toTunnels.key()
.TunnelsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tunnels>> augmentationType)
Remove an augmentation from this builder's product.TunnelsBuilder
setBfdLocalConfigs(Map<BfdLocalConfigsKey,BfdLocalConfigs> values)
Set the property corresponding toHwvtepTunnelAttributes.getBfdLocalConfigs()
to the specified value.TunnelsBuilder
setBfdParams(Map<BfdParamsKey,BfdParams> values)
Set the property corresponding toHwvtepTunnelAttributes.getBfdParams()
to the specified value.TunnelsBuilder
setBfdRemoteConfigs(Map<BfdRemoteConfigsKey,BfdRemoteConfigs> values)
Set the property corresponding toHwvtepTunnelAttributes.getBfdRemoteConfigs()
to the specified value.TunnelsBuilder
setBfdStatus(Map<BfdStatusKey,BfdStatus> values)
Set the property corresponding toHwvtepTunnelAttributes.getBfdStatus()
to the specified value.TunnelsBuilder
setLocalLocatorRef(HwvtepPhysicalLocatorRef value)
Set the property corresponding toHwvtepTunnelAttributes.getLocalLocatorRef()
to the specified value.TunnelsBuilder
setRemoteLocatorRef(HwvtepPhysicalLocatorRef value)
Set the property corresponding toHwvtepTunnelAttributes.getRemoteLocatorRef()
to the specified value.TunnelsBuilder
setTunnelUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
Set the property corresponding toHwvtepTunnelAttributes.getTunnelUuid()
to the specified value.TunnelsBuilder
withKey(TunnelsKey key)
-
-
-
Constructor Detail
-
TunnelsBuilder
public TunnelsBuilder()
Construct an empty builder.
-
TunnelsBuilder
public TunnelsBuilder(HwvtepTunnelAttributes arg)
Construct a new builder initialized from specifiedHwvtepTunnelAttributes
.- Parameters:
arg
- HwvtepTunnelAttributes from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public TunnelsKey key()
Return current value associated with the property corresponding toTunnels.key()
.- Returns:
- current value
-
getBfdLocalConfigs
public Map<BfdLocalConfigsKey,BfdLocalConfigs> getBfdLocalConfigs()
Return current value associated with the property corresponding toHwvtepTunnelAttributes.getBfdLocalConfigs()
.- Returns:
- current value
-
getBfdParams
public Map<BfdParamsKey,BfdParams> getBfdParams()
Return current value associated with the property corresponding toHwvtepTunnelAttributes.getBfdParams()
.- Returns:
- current value
-
getBfdRemoteConfigs
public Map<BfdRemoteConfigsKey,BfdRemoteConfigs> getBfdRemoteConfigs()
Return current value associated with the property corresponding toHwvtepTunnelAttributes.getBfdRemoteConfigs()
.- Returns:
- current value
-
getBfdStatus
public Map<BfdStatusKey,BfdStatus> getBfdStatus()
Return current value associated with the property corresponding toHwvtepTunnelAttributes.getBfdStatus()
.- Returns:
- current value
-
getLocalLocatorRef
public HwvtepPhysicalLocatorRef getLocalLocatorRef()
Return current value associated with the property corresponding toHwvtepTunnelAttributes.getLocalLocatorRef()
.- Returns:
- current value
-
getRemoteLocatorRef
public HwvtepPhysicalLocatorRef getRemoteLocatorRef()
Return current value associated with the property corresponding toHwvtepTunnelAttributes.getRemoteLocatorRef()
.- Returns:
- current value
-
getTunnelUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTunnelUuid()
Return current value associated with the property corresponding toHwvtepTunnelAttributes.getTunnelUuid()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tunnels>> 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 TunnelsBuilder withKey(TunnelsKey key)
-
setBfdLocalConfigs
public TunnelsBuilder setBfdLocalConfigs(Map<BfdLocalConfigsKey,BfdLocalConfigs> values)
Set the property corresponding toHwvtepTunnelAttributes.getBfdLocalConfigs()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setBfdParams
public TunnelsBuilder setBfdParams(Map<BfdParamsKey,BfdParams> values)
Set the property corresponding toHwvtepTunnelAttributes.getBfdParams()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setBfdRemoteConfigs
public TunnelsBuilder setBfdRemoteConfigs(Map<BfdRemoteConfigsKey,BfdRemoteConfigs> values)
Set the property corresponding toHwvtepTunnelAttributes.getBfdRemoteConfigs()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setBfdStatus
public TunnelsBuilder setBfdStatus(Map<BfdStatusKey,BfdStatus> values)
Set the property corresponding toHwvtepTunnelAttributes.getBfdStatus()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setLocalLocatorRef
public TunnelsBuilder setLocalLocatorRef(HwvtepPhysicalLocatorRef value)
Set the property corresponding toHwvtepTunnelAttributes.getLocalLocatorRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRemoteLocatorRef
public TunnelsBuilder setRemoteLocatorRef(HwvtepPhysicalLocatorRef value)
Set the property corresponding toHwvtepTunnelAttributes.getRemoteLocatorRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTunnelUuid
public TunnelsBuilder setTunnelUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
Set the property corresponding toHwvtepTunnelAttributes.getTunnelUuid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TunnelsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Tunnels> 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 TunnelsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tunnels>> 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
-
-