Class TunnelsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical._switch.attributes.TunnelsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Tunnels>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Tunnels,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TunnelsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Tunnels>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description TunnelsBuilder()
TunnelsBuilder(Tunnels base)
TunnelsBuilder(HwvtepTunnelAttributes arg)
-
Method Summary
-
-
-
Constructor Detail
-
TunnelsBuilder
public TunnelsBuilder()
-
TunnelsBuilder
public TunnelsBuilder(HwvtepTunnelAttributes arg)
-
TunnelsBuilder
public TunnelsBuilder(Tunnels base)
-
-
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:- HwvtepTunnelAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public TunnelsKey key()
-
getBfdLocalConfigs
public Map<BfdLocalConfigsKey,BfdLocalConfigs> getBfdLocalConfigs()
-
getBfdParams
public Map<BfdParamsKey,BfdParams> getBfdParams()
-
getBfdRemoteConfigs
public Map<BfdRemoteConfigsKey,BfdRemoteConfigs> getBfdRemoteConfigs()
-
getBfdStatus
public Map<BfdStatusKey,BfdStatus> getBfdStatus()
-
getLocalLocatorRef
public HwvtepPhysicalLocatorRef getLocalLocatorRef()
-
getRemoteLocatorRef
public HwvtepPhysicalLocatorRef getRemoteLocatorRef()
-
getTunnelUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTunnelUuid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tunnels>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public TunnelsBuilder withKey(TunnelsKey key)
-
setBfdLocalConfigs
public TunnelsBuilder setBfdLocalConfigs(Map<BfdLocalConfigsKey,BfdLocalConfigs> values)
-
setBfdParams
public TunnelsBuilder setBfdParams(Map<BfdParamsKey,BfdParams> values)
-
setBfdRemoteConfigs
public TunnelsBuilder setBfdRemoteConfigs(Map<BfdRemoteConfigsKey,BfdRemoteConfigs> values)
-
setBfdStatus
public TunnelsBuilder setBfdStatus(Map<BfdStatusKey,BfdStatus> values)
-
setLocalLocatorRef
public TunnelsBuilder setLocalLocatorRef(HwvtepPhysicalLocatorRef value)
-
setRemoteLocatorRef
public TunnelsBuilder setRemoteLocatorRef(HwvtepPhysicalLocatorRef value)
-
setTunnelUuid
public TunnelsBuilder setTunnelUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
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
-
build
public Tunnels build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Tunnels>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Tunnels,IllegalArgumentException>
-
-