Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.aug.nx.match
Class ArpTpaCaseValueBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.aug.nx.match.ArpTpaCaseValueBuilder
Class that builds
ArpTpaCaseValue
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:
ArpTpaCaseValue createArpTpaCaseValue(int fooXyzzy, int barBaz) {
return new ArpTpaCaseValueBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of ArpTpaCaseValue, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedArpTpaCaseValue
.Construct a new builder initialized from specifiedOfjNxmOfMatchArpTpaGrouping
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<ArpTpaCaseValue> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpTpaCaseValue>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull ArpTpaCaseValue
build()
A newArpTpaCaseValue
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toOfjNxmOfMatchArpTpaGrouping.getArpTpaValues()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpTpaCaseValue>> augmentationType) Remove an augmentation from this builder's product.setArpTpaValues
(ArpTpaValues value) Set the property corresponding toOfjNxmOfMatchArpTpaGrouping.getArpTpaValues()
to the specified value.
-
Constructor Details
-
ArpTpaCaseValueBuilder
public ArpTpaCaseValueBuilder()Construct an empty builder. -
ArpTpaCaseValueBuilder
Construct a new builder initialized from specifiedOfjNxmOfMatchArpTpaGrouping
.- Parameters:
arg
- OfjNxmOfMatchArpTpaGrouping from which the builder should be initialized
-
ArpTpaCaseValueBuilder
Construct a builder initialized with state from specifiedArpTpaCaseValue
.- Parameters:
base
- ArpTpaCaseValue from which the builder should be initialized
-
-
Method Details
-
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
-
getArpTpaValues
Return current value associated with the property corresponding toOfjNxmOfMatchArpTpaGrouping.getArpTpaValues()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpTpaCaseValue>> 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
-
setArpTpaValues
Set the property corresponding toOfjNxmOfMatchArpTpaGrouping.getArpTpaValues()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ArpTpaCaseValueBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ArpTpaCaseValue> 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 ArpTpaCaseValueBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpTpaCaseValue>> 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
A newArpTpaCaseValue
instance.- Returns:
- A new
ArpTpaCaseValue
instance.
-