Class TransportZoneBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZoneBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TransportZone>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TransportZone,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TransportZoneBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<TransportZone>
Class that buildsTransportZoneBuilder
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:
TransportZoneBuilder createTarget(int fooXyzzy, int barBaz) { return new TransportZoneBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TransportZoneBuilder, 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:
TransportZoneBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TransportZoneBuilder()
TransportZoneBuilder(TransportZone base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TransportZoneBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TransportZone> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TransportZone>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
TransportZone
build()
java.util.Map<DeviceVtepsKey,DeviceVteps>
getDeviceVteps()
java.lang.Class<? extends TunnelTypeBase>
getTunnelType()
java.util.Map<VtepsKey,Vteps>
getVteps()
java.lang.String
getZoneName()
TransportZoneKey
key()
TransportZoneBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TransportZone>> augmentationType)
Remove an augmentation from this builder's product.TransportZoneBuilder
setDeviceVteps(java.util.List<DeviceVteps> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDeviceVteps(Map)
instead.TransportZoneBuilder
setDeviceVteps(java.util.Map<DeviceVtepsKey,DeviceVteps> values)
TransportZoneBuilder
setTunnelType(java.lang.Class<? extends TunnelTypeBase> value)
TransportZoneBuilder
setVteps(java.util.List<Vteps> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVteps(Map)
instead.TransportZoneBuilder
setVteps(java.util.Map<VtepsKey,Vteps> values)
TransportZoneBuilder
setZoneName(java.lang.String value)
TransportZoneBuilder
withKey(TransportZoneKey key)
-
-
-
Constructor Detail
-
TransportZoneBuilder
public TransportZoneBuilder()
-
TransportZoneBuilder
public TransportZoneBuilder(TransportZone base)
-
-
Method Detail
-
key
public TransportZoneKey key()
-
getDeviceVteps
public java.util.Map<DeviceVtepsKey,DeviceVteps> getDeviceVteps()
-
getTunnelType
public java.lang.Class<? extends TunnelTypeBase> getTunnelType()
-
getZoneName
public java.lang.String getZoneName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TransportZone>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public TransportZoneBuilder withKey(TransportZoneKey key)
-
setDeviceVteps
public TransportZoneBuilder setDeviceVteps(java.util.Map<DeviceVtepsKey,DeviceVteps> values)
-
setDeviceVteps
@Deprecated(forRemoval=true) public TransportZoneBuilder setDeviceVteps(java.util.List<DeviceVteps> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDeviceVteps(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
java.lang.IllegalArgumentException
- if the list contains entries with the same keyjava.lang.NullPointerException
- if the list contains a null entry
-
setTunnelType
public TransportZoneBuilder setTunnelType(java.lang.Class<? extends TunnelTypeBase> value)
-
setVteps
public TransportZoneBuilder setVteps(java.util.Map<VtepsKey,Vteps> values)
-
setVteps
@Deprecated(forRemoval=true) public TransportZoneBuilder setVteps(java.util.List<Vteps> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVteps(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
java.lang.IllegalArgumentException
- if the list contains entries with the same keyjava.lang.NullPointerException
- if the list contains a null entry
-
setZoneName
public TransportZoneBuilder setZoneName(java.lang.String value)
-
addAugmentation
public TransportZoneBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TransportZone> 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 TransportZoneBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TransportZone>> 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 TransportZone build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TransportZone>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TransportZone,java.lang.IllegalArgumentException>
-
-