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