Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.intext.ip.port.map
Class IpPortMappingBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.intext.ip.port.map.IpPortMappingBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IpPortMapping>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IpPortMapping,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IpPortMappingBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<IpPortMapping>
Class that buildsIpPortMappingBuilder
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:
IpPortMappingBuilder createTarget(int fooXyzzy, int barBaz) { return new IpPortMappingBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpPortMappingBuilder, 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:
IpPortMappingBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IpPortMappingBuilder()
IpPortMappingBuilder(IpPortMapping base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IpPortMappingBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpPortMapping> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortMapping>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
IpPortMapping
build()
java.util.Map<IntextIpProtocolTypeKey,IntextIpProtocolType>
getIntextIpProtocolType()
org.opendaylight.yangtools.yang.common.Uint32
getRouterId()
IpPortMappingKey
key()
IpPortMappingBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortMapping>> augmentationType)
Remove an augmentation from this builder's product.IpPortMappingBuilder
setIntextIpProtocolType(java.util.List<IntextIpProtocolType> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIntextIpProtocolType(Map)
instead.IpPortMappingBuilder
setIntextIpProtocolType(java.util.Map<IntextIpProtocolTypeKey,IntextIpProtocolType> values)
IpPortMappingBuilder
setRouterId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRouterId(Uint32)
instead.IpPortMappingBuilder
setRouterId(org.opendaylight.yangtools.yang.common.Uint32 value)
IpPortMappingBuilder
withKey(IpPortMappingKey key)
-
-
-
Constructor Detail
-
IpPortMappingBuilder
public IpPortMappingBuilder()
-
IpPortMappingBuilder
public IpPortMappingBuilder(IpPortMapping base)
-
-
Method Detail
-
key
public IpPortMappingKey key()
-
getIntextIpProtocolType
public java.util.Map<IntextIpProtocolTypeKey,IntextIpProtocolType> getIntextIpProtocolType()
-
getRouterId
public org.opendaylight.yangtools.yang.common.Uint32 getRouterId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortMapping>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public IpPortMappingBuilder withKey(IpPortMappingKey key)
-
setIntextIpProtocolType
public IpPortMappingBuilder setIntextIpProtocolType(java.util.Map<IntextIpProtocolTypeKey,IntextIpProtocolType> values)
-
setIntextIpProtocolType
@Deprecated(forRemoval=true) public IpPortMappingBuilder setIntextIpProtocolType(java.util.List<IntextIpProtocolType> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIntextIpProtocolType(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
-
setRouterId
public IpPortMappingBuilder setRouterId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setRouterId
@Deprecated(forRemoval=true) public IpPortMappingBuilder setRouterId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRouterId(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public IpPortMappingBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpPortMapping> 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 IpPortMappingBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortMapping>> 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 IpPortMapping build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IpPortMapping>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IpPortMapping,java.lang.IllegalArgumentException>
-
-