Class IpPortMapBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.intext.ip.port.map.ip.port.mapping.intext.ip.protocol.type.IpPortMapBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IpPortMap>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IpPortMap,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IpPortMapBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<IpPortMap>
Class that buildsIpPortMapBuilder
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:
IpPortMapBuilder createTarget(int fooXyzzy, int barBaz) { return new IpPortMapBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpPortMapBuilder, 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:
IpPortMapBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IpPortMapBuilder()
IpPortMapBuilder(IpPortMap base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IpPortMapBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpPortMap> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortMap>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
IpPortMap
build()
IpPortExternal
getIpPortExternal()
java.lang.String
getIpPortInternal()
IpPortMapKey
key()
IpPortMapBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortMap>> augmentationType)
Remove an augmentation from this builder's product.IpPortMapBuilder
setIpPortExternal(IpPortExternal value)
IpPortMapBuilder
setIpPortInternal(java.lang.String value)
IpPortMapBuilder
withKey(IpPortMapKey key)
-
-
-
Constructor Detail
-
IpPortMapBuilder
public IpPortMapBuilder()
-
IpPortMapBuilder
public IpPortMapBuilder(IpPortMap base)
-
-
Method Detail
-
key
public IpPortMapKey key()
-
getIpPortExternal
public IpPortExternal getIpPortExternal()
-
getIpPortInternal
public java.lang.String getIpPortInternal()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortMap>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public IpPortMapBuilder withKey(IpPortMapKey key)
-
setIpPortExternal
public IpPortMapBuilder setIpPortExternal(IpPortExternal value)
-
setIpPortInternal
public IpPortMapBuilder setIpPortInternal(java.lang.String value)
-
addAugmentation
public IpPortMapBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpPortMap> 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 IpPortMapBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortMap>> 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
-
-