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