Class SnatIpMappingBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rpc.rev170209.snat.state.SnatIpMappingBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SnatIpMapping>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SnatIpMapping,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SnatIpMappingBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<SnatIpMapping>
Class that buildsSnatIpMappingBuilder
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:
SnatIpMappingBuilder createTarget(int fooXyzzy, int barBaz) { return new SnatIpMappingBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SnatIpMappingBuilder, 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:
SnatIpMappingBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SnatIpMappingBuilder()
SnatIpMappingBuilder(SnatIpMapping base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SnatIpMappingBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SnatIpMapping> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SnatIpMapping>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
SnatIpMapping
build()
java.lang.String
getExternalIp()
java.lang.String
getExternalPort()
java.lang.String
getInternalIp()
java.lang.String
getInternalPort()
java.lang.String
getProtocol()
SnatIpMappingBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SnatIpMapping>> augmentationType)
Remove an augmentation from this builder's product.SnatIpMappingBuilder
setExternalIp(java.lang.String value)
SnatIpMappingBuilder
setExternalPort(java.lang.String value)
SnatIpMappingBuilder
setInternalIp(java.lang.String value)
SnatIpMappingBuilder
setInternalPort(java.lang.String value)
SnatIpMappingBuilder
setProtocol(java.lang.String value)
-
-
-
Constructor Detail
-
SnatIpMappingBuilder
public SnatIpMappingBuilder()
-
SnatIpMappingBuilder
public SnatIpMappingBuilder(SnatIpMapping base)
-
-
Method Detail
-
getExternalIp
public java.lang.String getExternalIp()
-
getExternalPort
public java.lang.String getExternalPort()
-
getInternalIp
public java.lang.String getInternalIp()
-
getInternalPort
public java.lang.String getInternalPort()
-
getProtocol
public java.lang.String getProtocol()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SnatIpMapping>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setExternalIp
public SnatIpMappingBuilder setExternalIp(java.lang.String value)
-
setExternalPort
public SnatIpMappingBuilder setExternalPort(java.lang.String value)
-
setInternalIp
public SnatIpMappingBuilder setInternalIp(java.lang.String value)
-
setInternalPort
public SnatIpMappingBuilder setInternalPort(java.lang.String value)
-
setProtocol
public SnatIpMappingBuilder setProtocol(java.lang.String value)
-
addAugmentation
public SnatIpMappingBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SnatIpMapping> 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 SnatIpMappingBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SnatIpMapping>> 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 SnatIpMapping build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SnatIpMapping>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SnatIpMapping,java.lang.IllegalArgumentException>
-
-