Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.aug.nx.match
Class EthSrcCaseValueBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.aug.nx.match.EthSrcCaseValueBuilder
-
@Generated("mdsal-binding-generator") public class EthSrcCaseValueBuilder extends Object
Class that buildsEthSrcCaseValue
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:
EthSrcCaseValue createEthSrcCaseValue(int fooXyzzy, int barBaz) { return new EthSrcCaseValueBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EthSrcCaseValue, 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:
EthSrcCaseValue
- 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 EthSrcCaseValueBuilder()
Construct an empty builder.EthSrcCaseValueBuilder(EthSrcCaseValue base)
Construct a builder initialized with state from specifiedEthSrcCaseValue
.EthSrcCaseValueBuilder(OfjNxmOfMatchEthSrcGrouping arg)
Construct a new builder initialized from specifiedOfjNxmOfMatchEthSrcGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EthSrcCaseValueBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EthSrcCaseValue> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EthSrcCaseValue>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull EthSrcCaseValue
build()
A newEthSrcCaseValue
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.EthSrcValues
getEthSrcValues()
Return current value associated with the property corresponding toOfjNxmOfMatchEthSrcGrouping.getEthSrcValues()
.EthSrcCaseValueBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthSrcCaseValue>> augmentationType)
Remove an augmentation from this builder's product.EthSrcCaseValueBuilder
setEthSrcValues(EthSrcValues value)
Set the property corresponding toOfjNxmOfMatchEthSrcGrouping.getEthSrcValues()
to the specified value.
-
-
-
Constructor Detail
-
EthSrcCaseValueBuilder
public EthSrcCaseValueBuilder()
Construct an empty builder.
-
EthSrcCaseValueBuilder
public EthSrcCaseValueBuilder(OfjNxmOfMatchEthSrcGrouping arg)
Construct a new builder initialized from specifiedOfjNxmOfMatchEthSrcGrouping
.- Parameters:
arg
- OfjNxmOfMatchEthSrcGrouping from which the builder should be initialized
-
EthSrcCaseValueBuilder
public EthSrcCaseValueBuilder(EthSrcCaseValue base)
Construct a builder initialized with state from specifiedEthSrcCaseValue
.- Parameters:
base
- EthSrcCaseValue 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
-
getEthSrcValues
public EthSrcValues getEthSrcValues()
Return current value associated with the property corresponding toOfjNxmOfMatchEthSrcGrouping.getEthSrcValues()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EthSrcCaseValue>> 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
-
setEthSrcValues
public EthSrcCaseValueBuilder setEthSrcValues(EthSrcValues value)
Set the property corresponding toOfjNxmOfMatchEthSrcGrouping.getEthSrcValues()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public EthSrcCaseValueBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EthSrcCaseValue> 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 EthSrcCaseValueBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthSrcCaseValue>> 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 EthSrcCaseValue build()
A newEthSrcCaseValue
instance.- Returns:
- A new
EthSrcCaseValue
instance.
-
-