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