Class NxActionRegLoad2Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.nx.action.reg.load2.grouping.NxActionRegLoad2Builder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxActionRegLoad2>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxActionRegLoad2,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NxActionRegLoad2Builder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxActionRegLoad2>
Class that buildsNxActionRegLoad2
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:
NxActionRegLoad2 createNxActionRegLoad2(int fooXyzzy, int barBaz) { return new NxActionRegLoad2Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxActionRegLoad2, 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:
NxActionRegLoad2
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxActionRegLoad2Builder()
NxActionRegLoad2Builder(MatchEntriesGrouping arg)
NxActionRegLoad2Builder(NxActionRegLoad2 base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NxActionRegLoad2Builder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegLoad2> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegLoad2>>
E$$augmentation(Class<E$$> augmentationType)
NxActionRegLoad2
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<MatchEntry>
getMatchEntry()
NxActionRegLoad2Builder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegLoad2>> augmentationType)
Remove an augmentation from this builder's product.NxActionRegLoad2Builder
setMatchEntry(List<MatchEntry> values)
-
-
-
Constructor Detail
-
NxActionRegLoad2Builder
public NxActionRegLoad2Builder()
-
NxActionRegLoad2Builder
public NxActionRegLoad2Builder(MatchEntriesGrouping arg)
-
NxActionRegLoad2Builder
public NxActionRegLoad2Builder(NxActionRegLoad2 base)
-
-
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:- MatchEntriesGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMatchEntry
public List<MatchEntry> getMatchEntry()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegLoad2>> E$$ augmentation(Class<E$$> augmentationType)
-
setMatchEntry
public NxActionRegLoad2Builder setMatchEntry(List<MatchEntry> values)
-
addAugmentation
public NxActionRegLoad2Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegLoad2> 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 NxActionRegLoad2Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionRegLoad2>> 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 NxActionRegLoad2 build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxActionRegLoad2>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxActionRegLoad2,IllegalArgumentException>
-
-