Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.aug.nx.match
Class TcpSrcCaseValueBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.aug.nx.match.TcpSrcCaseValueBuilder
-
@Generated("mdsal-binding-generator") public class TcpSrcCaseValueBuilder extends Object
Class that buildsTcpSrcCaseValue
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:
TcpSrcCaseValue createTcpSrcCaseValue(int fooXyzzy, int barBaz) { return new TcpSrcCaseValueBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TcpSrcCaseValue, 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:
TcpSrcCaseValue
- 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 TcpSrcCaseValueBuilder()
Construct an empty builder.TcpSrcCaseValueBuilder(TcpSrcCaseValue base)
Construct a builder initialized with state from specifiedTcpSrcCaseValue
.TcpSrcCaseValueBuilder(OfjNxmOfMatchTcpSrcGrouping arg)
Construct a new builder initialized from specifiedOfjNxmOfMatchTcpSrcGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TcpSrcCaseValueBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TcpSrcCaseValue> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpSrcCaseValue>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull TcpSrcCaseValue
build()
A newTcpSrcCaseValue
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.TcpSrcValues
getTcpSrcValues()
Return current value associated with the property corresponding toOfjNxmOfMatchTcpSrcGrouping.getTcpSrcValues()
.TcpSrcCaseValueBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpSrcCaseValue>> augmentationType)
Remove an augmentation from this builder's product.TcpSrcCaseValueBuilder
setTcpSrcValues(TcpSrcValues value)
Set the property corresponding toOfjNxmOfMatchTcpSrcGrouping.getTcpSrcValues()
to the specified value.
-
-
-
Constructor Detail
-
TcpSrcCaseValueBuilder
public TcpSrcCaseValueBuilder()
Construct an empty builder.
-
TcpSrcCaseValueBuilder
public TcpSrcCaseValueBuilder(OfjNxmOfMatchTcpSrcGrouping arg)
Construct a new builder initialized from specifiedOfjNxmOfMatchTcpSrcGrouping
.- Parameters:
arg
- OfjNxmOfMatchTcpSrcGrouping from which the builder should be initialized
-
TcpSrcCaseValueBuilder
public TcpSrcCaseValueBuilder(TcpSrcCaseValue base)
Construct a builder initialized with state from specifiedTcpSrcCaseValue
.- Parameters:
base
- TcpSrcCaseValue from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getTcpSrcValues
public TcpSrcValues getTcpSrcValues()
Return current value associated with the property corresponding toOfjNxmOfMatchTcpSrcGrouping.getTcpSrcValues()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpSrcCaseValue>> 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
-
setTcpSrcValues
public TcpSrcCaseValueBuilder setTcpSrcValues(TcpSrcValues value)
Set the property corresponding toOfjNxmOfMatchTcpSrcGrouping.getTcpSrcValues()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TcpSrcCaseValueBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TcpSrcCaseValue> 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 TcpSrcCaseValueBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpSrcCaseValue>> 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 TcpSrcCaseValue build()
A newTcpSrcCaseValue
instance.- Returns:
- A new
TcpSrcCaseValue
instance.
-
-