Class NatTraversalBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.nat.traversal.NatTraversalBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NatTraversal>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NatTraversal,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NatTraversalBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<NatTraversal>
Class that buildsNatTraversalBuilder
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:
NatTraversalBuilder createTarget(int fooXyzzy, int barBaz) { return new NatTraversalBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NatTraversalBuilder, 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:
NatTraversalBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NatTraversalBuilder()
NatTraversalBuilder(NatTraversal base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NatTraversalBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NatTraversal> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NatTraversal>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
NatTraversal
build()
org.opendaylight.yangtools.yang.common.Uint16
getEtrUdpPort()
SimpleAddress
getGlobalEtrRloc()
SimpleAddress
getMsRloc()
org.opendaylight.yangtools.yang.common.Uint16
getMsUdpPort()
SimpleAddress
getPrivateEtrRloc()
java.util.List<SimpleAddress>
getRtrRlocs()
NatTraversalBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NatTraversal>> augmentationType)
Remove an augmentation from this builder's product.NatTraversalBuilder
setEtrUdpPort(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEtrUdpPort(Uint16)
instead.NatTraversalBuilder
setEtrUdpPort(org.opendaylight.yangtools.yang.common.Uint16 value)
NatTraversalBuilder
setGlobalEtrRloc(SimpleAddress value)
NatTraversalBuilder
setMsRloc(SimpleAddress value)
NatTraversalBuilder
setMsUdpPort(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMsUdpPort(Uint16)
instead.NatTraversalBuilder
setMsUdpPort(org.opendaylight.yangtools.yang.common.Uint16 value)
NatTraversalBuilder
setPrivateEtrRloc(SimpleAddress value)
NatTraversalBuilder
setRtrRlocs(java.util.List<SimpleAddress> values)
-
-
-
Constructor Detail
-
NatTraversalBuilder
public NatTraversalBuilder()
-
NatTraversalBuilder
public NatTraversalBuilder(NatTraversal base)
-
-
Method Detail
-
getEtrUdpPort
public org.opendaylight.yangtools.yang.common.Uint16 getEtrUdpPort()
-
getGlobalEtrRloc
public SimpleAddress getGlobalEtrRloc()
-
getMsRloc
public SimpleAddress getMsRloc()
-
getMsUdpPort
public org.opendaylight.yangtools.yang.common.Uint16 getMsUdpPort()
-
getPrivateEtrRloc
public SimpleAddress getPrivateEtrRloc()
-
getRtrRlocs
public java.util.List<SimpleAddress> getRtrRlocs()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NatTraversal>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setEtrUdpPort
public NatTraversalBuilder setEtrUdpPort(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setEtrUdpPort
@Deprecated(forRemoval=true) public NatTraversalBuilder setEtrUdpPort(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEtrUdpPort(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setGlobalEtrRloc
public NatTraversalBuilder setGlobalEtrRloc(SimpleAddress value)
-
setMsRloc
public NatTraversalBuilder setMsRloc(SimpleAddress value)
-
setMsUdpPort
public NatTraversalBuilder setMsUdpPort(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMsUdpPort
@Deprecated(forRemoval=true) public NatTraversalBuilder setMsUdpPort(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMsUdpPort(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPrivateEtrRloc
public NatTraversalBuilder setPrivateEtrRloc(SimpleAddress value)
-
setRtrRlocs
public NatTraversalBuilder setRtrRlocs(java.util.List<SimpleAddress> values)
-
addAugmentation
public NatTraversalBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NatTraversal> 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 NatTraversalBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NatTraversal>> 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 NatTraversal build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NatTraversal>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NatTraversal,java.lang.IllegalArgumentException>
-
-