Class IntextIpProtocolTypeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.intext.ip.port.map.ip.port.mapping.IntextIpProtocolTypeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IntextIpProtocolType>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IntextIpProtocolType,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IntextIpProtocolTypeBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<IntextIpProtocolType>
Class that buildsIntextIpProtocolTypeBuilder
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:
IntextIpProtocolTypeBuilder createTarget(int fooXyzzy, int barBaz) { return new IntextIpProtocolTypeBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IntextIpProtocolTypeBuilder, 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:
IntextIpProtocolTypeBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IntextIpProtocolTypeBuilder()
IntextIpProtocolTypeBuilder(IntextIpProtocolType base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IntextIpProtocolTypeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IntextIpProtocolType> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IntextIpProtocolType>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
IntextIpProtocolType
build()
java.util.Map<IpPortMapKey,IpPortMap>
getIpPortMap()
ProtocolTypes
getProtocol()
IntextIpProtocolTypeKey
key()
IntextIpProtocolTypeBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IntextIpProtocolType>> augmentationType)
Remove an augmentation from this builder's product.IntextIpProtocolTypeBuilder
setIpPortMap(java.util.List<IpPortMap> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpPortMap(Map)
instead.IntextIpProtocolTypeBuilder
setIpPortMap(java.util.Map<IpPortMapKey,IpPortMap> values)
IntextIpProtocolTypeBuilder
setProtocol(ProtocolTypes value)
IntextIpProtocolTypeBuilder
withKey(IntextIpProtocolTypeKey key)
-
-
-
Constructor Detail
-
IntextIpProtocolTypeBuilder
public IntextIpProtocolTypeBuilder()
-
IntextIpProtocolTypeBuilder
public IntextIpProtocolTypeBuilder(IntextIpProtocolType base)
-
-
Method Detail
-
key
public IntextIpProtocolTypeKey key()
-
getIpPortMap
public java.util.Map<IpPortMapKey,IpPortMap> getIpPortMap()
-
getProtocol
public ProtocolTypes getProtocol()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IntextIpProtocolType>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public IntextIpProtocolTypeBuilder withKey(IntextIpProtocolTypeKey key)
-
setIpPortMap
public IntextIpProtocolTypeBuilder setIpPortMap(java.util.Map<IpPortMapKey,IpPortMap> values)
-
setIpPortMap
@Deprecated(forRemoval=true) public IntextIpProtocolTypeBuilder setIpPortMap(java.util.List<IpPortMap> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpPortMap(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
-
setProtocol
public IntextIpProtocolTypeBuilder setProtocol(ProtocolTypes value)
-
addAugmentation
public IntextIpProtocolTypeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IntextIpProtocolType> 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 IntextIpProtocolTypeBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IntextIpProtocolType>> 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 IntextIpProtocolType build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IntextIpProtocolType>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IntextIpProtocolType,java.lang.IllegalArgumentException>
-
-