Class IpMappingBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.intext.ip.map.IpMappingBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IpMapping>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IpMapping,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class IpMappingBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<IpMapping>
Class that buildsIpMappingBuilder
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:
IpMappingBuilder createTarget(int fooXyzzy, int barBaz) { return new IpMappingBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpMappingBuilder, 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:
IpMappingBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IpMappingBuilder()
IpMappingBuilder(IpMapping base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IpMappingBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpMapping>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IpMapping> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.IpMappingBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpMapping> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpMapping>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
IpMapping
build()
java.util.Map<IpMapKey,IpMap>
getIpMap()
org.opendaylight.yangtools.yang.common.Uint32
getSegmentId()
IpMappingKey
key()
IpMappingBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpMapping>> augmentationType)
Remove an augmentation from this builder's product.IpMappingBuilder
setIpMap(java.util.List<IpMap> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpMap(Map)
instead.IpMappingBuilder
setIpMap(java.util.Map<IpMapKey,IpMap> values)
IpMappingBuilder
setSegmentId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSegmentId(Uint32)
instead.IpMappingBuilder
setSegmentId(org.opendaylight.yangtools.yang.common.Uint32 value)
IpMappingBuilder
withKey(IpMappingKey key)
-
-
-
Constructor Detail
-
IpMappingBuilder
public IpMappingBuilder()
-
IpMappingBuilder
public IpMappingBuilder(IpMapping base)
-
-
Method Detail
-
key
public IpMappingKey key()
-
getSegmentId
public org.opendaylight.yangtools.yang.common.Uint32 getSegmentId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpMapping>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public IpMappingBuilder withKey(IpMappingKey key)
-
setIpMap
public IpMappingBuilder setIpMap(java.util.Map<IpMapKey,IpMap> values)
-
setIpMap
@Deprecated(forRemoval=true) public IpMappingBuilder setIpMap(java.util.List<IpMap> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpMap(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
-
setSegmentId
public IpMappingBuilder setSegmentId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSegmentId
@Deprecated(forRemoval=true) public IpMappingBuilder setSegmentId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSegmentId(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public IpMappingBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpMapping> 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
-
addAugmentation
@Deprecated(forRemoval=true) public IpMappingBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpMapping>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IpMapping> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public IpMappingBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpMapping>> 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
-
-