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
-
@Generated("mdsal-binding-generator") public class NatTraversalBuilder extends java.lang.Object
Class that buildsNatTraversal
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:
NatTraversal createNatTraversal(int fooXyzzy, int barBaz) { return new NatTraversalBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NatTraversal, 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 opportunities, 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:
NatTraversal
- 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
-
-
Constructor Summary
Constructors Constructor Description NatTraversalBuilder()
Construct an empty builder.NatTraversalBuilder(NatTraversal base)
Construct a builder initialized with state from specifiedNatTraversal
.
-
Method Summary
All Methods Instance Methods Concrete 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)
Return the specified augmentation, if it is present in this builder.@NonNull NatTraversal
build()
A newNatTraversal
instance.org.opendaylight.yangtools.yang.common.Uint16
getEtrUdpPort()
Return current value associated with the property corresponding toNatTraversal.getEtrUdpPort()
.SimpleAddress
getGlobalEtrRloc()
Return current value associated with the property corresponding toNatTraversal.getGlobalEtrRloc()
.SimpleAddress
getMsRloc()
Return current value associated with the property corresponding toNatTraversal.getMsRloc()
.org.opendaylight.yangtools.yang.common.Uint16
getMsUdpPort()
Return current value associated with the property corresponding toNatTraversal.getMsUdpPort()
.SimpleAddress
getPrivateEtrRloc()
Return current value associated with the property corresponding toNatTraversal.getPrivateEtrRloc()
.java.util.Set<SimpleAddress>
getRtrRlocs()
Return current value associated with the property corresponding toNatTraversal.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(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNatTraversal.getEtrUdpPort()
to the specified value.NatTraversalBuilder
setGlobalEtrRloc(SimpleAddress value)
Set the property corresponding toNatTraversal.getGlobalEtrRloc()
to the specified value.NatTraversalBuilder
setMsRloc(SimpleAddress value)
Set the property corresponding toNatTraversal.getMsRloc()
to the specified value.NatTraversalBuilder
setMsUdpPort(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNatTraversal.getMsUdpPort()
to the specified value.NatTraversalBuilder
setPrivateEtrRloc(SimpleAddress value)
Set the property corresponding toNatTraversal.getPrivateEtrRloc()
to the specified value.NatTraversalBuilder
setRtrRlocs(java.util.Set<SimpleAddress> values)
Set the property corresponding toNatTraversal.getRtrRlocs()
to the specified value.
-
-
-
Constructor Detail
-
NatTraversalBuilder
public NatTraversalBuilder()
Construct an empty builder.
-
NatTraversalBuilder
public NatTraversalBuilder(NatTraversal base)
Construct a builder initialized with state from specifiedNatTraversal
.- Parameters:
base
- NatTraversal from which the builder should be initialized
-
-
Method Detail
-
getEtrUdpPort
public org.opendaylight.yangtools.yang.common.Uint16 getEtrUdpPort()
Return current value associated with the property corresponding toNatTraversal.getEtrUdpPort()
.- Returns:
- current value
-
getGlobalEtrRloc
public SimpleAddress getGlobalEtrRloc()
Return current value associated with the property corresponding toNatTraversal.getGlobalEtrRloc()
.- Returns:
- current value
-
getMsRloc
public SimpleAddress getMsRloc()
Return current value associated with the property corresponding toNatTraversal.getMsRloc()
.- Returns:
- current value
-
getMsUdpPort
public org.opendaylight.yangtools.yang.common.Uint16 getMsUdpPort()
Return current value associated with the property corresponding toNatTraversal.getMsUdpPort()
.- Returns:
- current value
-
getPrivateEtrRloc
public SimpleAddress getPrivateEtrRloc()
Return current value associated with the property corresponding toNatTraversal.getPrivateEtrRloc()
.- Returns:
- current value
-
getRtrRlocs
public java.util.Set<SimpleAddress> getRtrRlocs()
Return current value associated with the property corresponding toNatTraversal.getRtrRlocs()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NatTraversal>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
java.lang.NullPointerException
- ifaugmentType
isnull
-
setEtrUdpPort
public NatTraversalBuilder setEtrUdpPort(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNatTraversal.getEtrUdpPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGlobalEtrRloc
public NatTraversalBuilder setGlobalEtrRloc(SimpleAddress value)
Set the property corresponding toNatTraversal.getGlobalEtrRloc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMsRloc
public NatTraversalBuilder setMsRloc(SimpleAddress value)
Set the property corresponding toNatTraversal.getMsRloc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMsUdpPort
public NatTraversalBuilder setMsUdpPort(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNatTraversal.getMsUdpPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrivateEtrRloc
public NatTraversalBuilder setPrivateEtrRloc(SimpleAddress value)
Set the property corresponding toNatTraversal.getPrivateEtrRloc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRtrRlocs
public NatTraversalBuilder setRtrRlocs(java.util.Set<SimpleAddress> values)
Set the property corresponding toNatTraversal.getRtrRlocs()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
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 @NonNull NatTraversal build()
A newNatTraversal
instance.- Returns:
- A new
NatTraversal
instance.
-
-