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