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