Class UdpSrcValuesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.nxm.of.match.udp.src.grouping.UdpSrcValuesBuilder
-
@Generated("mdsal-binding-generator") public class UdpSrcValuesBuilder extends Object
Class that buildsUdpSrcValues
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:
UdpSrcValues createUdpSrcValues(int fooXyzzy, int barBaz) { return new UdpSrcValuesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UdpSrcValues, 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:
UdpSrcValues
- 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 UdpSrcValuesBuilder()
Construct an empty builder.UdpSrcValuesBuilder(UdpSrcValues base)
Construct a builder initialized with state from specifiedUdpSrcValues
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UdpSrcValuesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrcValues> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrcValues>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull UdpSrcValues
build()
A newUdpSrcValues
instance.org.opendaylight.yangtools.yang.common.Uint16
getMask()
Return current value associated with the property corresponding toUdpSrcValues.getMask()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getPort()
Return current value associated with the property corresponding toUdpSrcValues.getPort()
.UdpSrcValuesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrcValues>> augmentationType)
Remove an augmentation from this builder's product.UdpSrcValuesBuilder
setMask(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toUdpSrcValues.getMask()
to the specified value.UdpSrcValuesBuilder
setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
Set the property corresponding toUdpSrcValues.getPort()
to the specified value.
-
-
-
Constructor Detail
-
UdpSrcValuesBuilder
public UdpSrcValuesBuilder()
Construct an empty builder.
-
UdpSrcValuesBuilder
public UdpSrcValuesBuilder(UdpSrcValues base)
Construct a builder initialized with state from specifiedUdpSrcValues
.- Parameters:
base
- UdpSrcValues from which the builder should be initialized
-
-
Method Detail
-
getMask
public org.opendaylight.yangtools.yang.common.Uint16 getMask()
Return current value associated with the property corresponding toUdpSrcValues.getMask()
.- Returns:
- current value
-
getPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPort()
Return current value associated with the property corresponding toUdpSrcValues.getPort()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrcValues>> E$$ augmentation(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:
NullPointerException
- ifaugmentType
isnull
-
setMask
public UdpSrcValuesBuilder setMask(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toUdpSrcValues.getMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPort
public UdpSrcValuesBuilder setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
Set the property corresponding toUdpSrcValues.getPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public UdpSrcValuesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrcValues> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public UdpSrcValuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrcValues>> 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 UdpSrcValues build()
A newUdpSrcValues
instance.- Returns:
- A new
UdpSrcValues
instance.
-
-