Package org.opendaylight.yang.gen.v1.urn.opendaylight.bulk.flow.service.rev150608.bulk.flow.ds.list.grouping
Class BulkFlowDsItemBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.bulk.flow.service.rev150608.bulk.flow.ds.list.grouping.BulkFlowDsItemBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BulkFlowDsItem>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BulkFlowDsItem,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BulkFlowDsItemBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BulkFlowDsItem>
Class that buildsBulkFlowDsItem
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:
BulkFlowDsItem createBulkFlowDsItem(int fooXyzzy, int barBaz) { return new BulkFlowDsItemBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BulkFlowDsItem, 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:
BulkFlowDsItem
,Builder
-
-
Constructor Summary
Constructors Constructor Description BulkFlowDsItemBuilder()
BulkFlowDsItemBuilder(BulkFlowDsItem base)
BulkFlowDsItemBuilder(BulkFlowBaseContentGrouping arg)
BulkFlowDsItemBuilder(Flow arg)
BulkFlowDsItemBuilder(GenericFlowAttributes arg)
BulkFlowDsItemBuilder(NodeContextRef arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BulkFlowDsItemBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BulkFlowDsItem> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BulkFlowDsItem>>
E$$augmentation(Class<E$$> augmentationType)
BulkFlowDsItem
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrier()
org.opendaylight.yangtools.yang.common.Uint32
getBufferId()
String
getContainerName()
FlowCookie
getCookie()
FlowCookie
getCookieMask()
FlowModFlags
getFlags()
FlowId
getFlowId()
String
getFlowName()
org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
Boolean
getInstallHw()
Instructions
getInstructions()
Match
getMatch()
NodeRef
getNode()
org.opendaylight.yangtools.yang.common.Uint32
getOutGroup()
org.opendaylight.yangtools.yang.common.Uint64
getOutPort()
org.opendaylight.yangtools.yang.common.Uint16
getPriority()
Boolean
getStrict()
org.opendaylight.yangtools.yang.common.Uint8
getTableId()
BulkFlowDsItemBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BulkFlowDsItem>> augmentationType)
Remove an augmentation from this builder's product.BulkFlowDsItemBuilder
setBarrier(Boolean value)
BulkFlowDsItemBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
BulkFlowDsItemBuilder
setContainerName(String value)
BulkFlowDsItemBuilder
setCookie(FlowCookie value)
BulkFlowDsItemBuilder
setCookieMask(FlowCookie value)
BulkFlowDsItemBuilder
setFlags(FlowModFlags value)
BulkFlowDsItemBuilder
setFlowId(FlowId value)
BulkFlowDsItemBuilder
setFlowName(String value)
BulkFlowDsItemBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
BulkFlowDsItemBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
BulkFlowDsItemBuilder
setInstallHw(Boolean value)
BulkFlowDsItemBuilder
setInstructions(Instructions value)
BulkFlowDsItemBuilder
setMatch(Match value)
BulkFlowDsItemBuilder
setNode(NodeRef value)
BulkFlowDsItemBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
BulkFlowDsItemBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
BulkFlowDsItemBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
BulkFlowDsItemBuilder
setStrict(Boolean value)
BulkFlowDsItemBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
BulkFlowDsItemBuilder
public BulkFlowDsItemBuilder()
-
BulkFlowDsItemBuilder
public BulkFlowDsItemBuilder(BulkFlowBaseContentGrouping arg)
-
BulkFlowDsItemBuilder
public BulkFlowDsItemBuilder(NodeContextRef arg)
-
BulkFlowDsItemBuilder
public BulkFlowDsItemBuilder(Flow arg)
-
BulkFlowDsItemBuilder
public BulkFlowDsItemBuilder(GenericFlowAttributes arg)
-
BulkFlowDsItemBuilder
public BulkFlowDsItemBuilder(BulkFlowDsItem 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:- BulkFlowBaseContentGrouping
- Flow
- GenericFlowAttributes
- NodeContextRef
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBarrier
public Boolean getBarrier()
-
getBufferId
public org.opendaylight.yangtools.yang.common.Uint32 getBufferId()
-
getContainerName
public String getContainerName()
-
getCookie
public FlowCookie getCookie()
-
getCookieMask
public FlowCookie getCookieMask()
-
getFlags
public FlowModFlags getFlags()
-
getFlowId
public FlowId getFlowId()
-
getFlowName
public String getFlowName()
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
-
getInstallHw
public Boolean getInstallHw()
-
getInstructions
public Instructions getInstructions()
-
getMatch
public Match getMatch()
-
getNode
public NodeRef getNode()
-
getOutGroup
public org.opendaylight.yangtools.yang.common.Uint32 getOutGroup()
-
getOutPort
public org.opendaylight.yangtools.yang.common.Uint64 getOutPort()
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint16 getPriority()
-
getStrict
public Boolean getStrict()
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BulkFlowDsItem>> E$$ augmentation(Class<E$$> augmentationType)
-
setBarrier
public BulkFlowDsItemBuilder setBarrier(Boolean value)
-
setBufferId
public BulkFlowDsItemBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setContainerName
public BulkFlowDsItemBuilder setContainerName(String value)
-
setCookie
public BulkFlowDsItemBuilder setCookie(FlowCookie value)
-
setCookieMask
public BulkFlowDsItemBuilder setCookieMask(FlowCookie value)
-
setFlags
public BulkFlowDsItemBuilder setFlags(FlowModFlags value)
-
setFlowId
public BulkFlowDsItemBuilder setFlowId(FlowId value)
-
setFlowName
public BulkFlowDsItemBuilder setFlowName(String value)
-
setHardTimeout
public BulkFlowDsItemBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
public BulkFlowDsItemBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setInstallHw
public BulkFlowDsItemBuilder setInstallHw(Boolean value)
-
setInstructions
public BulkFlowDsItemBuilder setInstructions(Instructions value)
-
setMatch
public BulkFlowDsItemBuilder setMatch(Match value)
-
setNode
public BulkFlowDsItemBuilder setNode(NodeRef value)
-
setOutGroup
public BulkFlowDsItemBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutPort
public BulkFlowDsItemBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setPriority
public BulkFlowDsItemBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setStrict
public BulkFlowDsItemBuilder setStrict(Boolean value)
-
setTableId
public BulkFlowDsItemBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
addAugmentation
public BulkFlowDsItemBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BulkFlowDsItem> 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 BulkFlowDsItemBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BulkFlowDsItem>> 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 BulkFlowDsItem build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BulkFlowDsItem>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BulkFlowDsItem,IllegalArgumentException>
-
-