Class NxActionLearnBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.nx.action.learn.grouping.NxActionLearnBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxActionLearn>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxActionLearn,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NxActionLearnBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxActionLearn>
Class that buildsNxActionLearn
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:
NxActionLearn createNxActionLearn(int fooXyzzy, int barBaz) { return new NxActionLearnBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxActionLearn, 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:
NxActionLearn
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxActionLearnBuilder()
NxActionLearnBuilder(NxActionLearn base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NxActionLearnBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearn> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearn>>
E$$augmentation(Class<E$$> augmentationType)
NxActionLearn
build()
org.opendaylight.yangtools.yang.common.Uint64
getCookie()
org.opendaylight.yangtools.yang.common.Uint16
getFinHardTimeout()
org.opendaylight.yangtools.yang.common.Uint16
getFinIdleTimeout()
org.opendaylight.yangtools.yang.common.Uint16
getFlags()
List<FlowMods>
getFlowMods()
org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
org.opendaylight.yangtools.yang.common.Uint16
getPriority()
org.opendaylight.yangtools.yang.common.Uint8
getTableId()
NxActionLearnBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearn>> augmentationType)
Remove an augmentation from this builder's product.NxActionLearnBuilder
setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
NxActionLearnBuilder
setFinHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
NxActionLearnBuilder
setFinIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
NxActionLearnBuilder
setFlags(org.opendaylight.yangtools.yang.common.Uint16 value)
NxActionLearnBuilder
setFlowMods(List<FlowMods> values)
NxActionLearnBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
NxActionLearnBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
NxActionLearnBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
NxActionLearnBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
NxActionLearnBuilder
public NxActionLearnBuilder()
-
NxActionLearnBuilder
public NxActionLearnBuilder(NxActionLearn base)
-
-
Method Detail
-
getCookie
public org.opendaylight.yangtools.yang.common.Uint64 getCookie()
-
getFinHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getFinHardTimeout()
-
getFinIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getFinIdleTimeout()
-
getFlags
public org.opendaylight.yangtools.yang.common.Uint16 getFlags()
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint16 getPriority()
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearn>> E$$ augmentation(Class<E$$> augmentationType)
-
setCookie
public NxActionLearnBuilder setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setFinHardTimeout
public NxActionLearnBuilder setFinHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setFinIdleTimeout
public NxActionLearnBuilder setFinIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setFlags
public NxActionLearnBuilder setFlags(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setFlowMods
public NxActionLearnBuilder setFlowMods(List<FlowMods> values)
-
setHardTimeout
public NxActionLearnBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
public NxActionLearnBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setPriority
public NxActionLearnBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setTableId
public NxActionLearnBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
addAugmentation
public NxActionLearnBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearn> 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 NxActionLearnBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearn>> 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 NxActionLearn build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxActionLearn>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxActionLearn,IllegalArgumentException>
-
-