Class NatserviceConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.config.rev170206.NatserviceConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NatserviceConfig>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NatserviceConfig,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class NatserviceConfigBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<NatserviceConfig>
Class that buildsNatserviceConfigBuilder
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:
NatserviceConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new NatserviceConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NatserviceConfigBuilder, 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:
NatserviceConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NatserviceConfigBuilder()
NatserviceConfigBuilder(NatserviceConfig base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NatserviceConfigBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NatserviceConfig>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NatserviceConfig> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NatserviceConfig>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
NatserviceConfig
build()
NatserviceConfig.NatMode
getNatMode()
org.opendaylight.yangtools.yang.common.Uint32
getSnatPuntTimeout()
NatserviceConfigBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NatserviceConfig>> augmentationType)
NatserviceConfigBuilder
setNatMode(NatserviceConfig.NatMode value)
NatserviceConfigBuilder
setSnatPuntTimeout(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSnatPuntTimeout(Uint32)} instead.NatserviceConfigBuilder
setSnatPuntTimeout(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
NatserviceConfigBuilder
public NatserviceConfigBuilder()
-
NatserviceConfigBuilder
public NatserviceConfigBuilder(NatserviceConfig base)
-
-
Method Detail
-
getNatMode
public NatserviceConfig.NatMode getNatMode()
-
getSnatPuntTimeout
public org.opendaylight.yangtools.yang.common.Uint32 getSnatPuntTimeout()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NatserviceConfig>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setNatMode
public NatserviceConfigBuilder setNatMode(NatserviceConfig.NatMode value)
-
setSnatPuntTimeout
public NatserviceConfigBuilder setSnatPuntTimeout(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSnatPuntTimeout
@Deprecated(forRemoval=true) public NatserviceConfigBuilder setSnatPuntTimeout(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSnatPuntTimeout(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public NatserviceConfigBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NatserviceConfig>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NatserviceConfig> augmentationValue)
-
removeAugmentation
public NatserviceConfigBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NatserviceConfig>> augmentationType)
-
build
public NatserviceConfig build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NatserviceConfig>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NatserviceConfig,java.lang.IllegalArgumentException>
-
-