Package org.opendaylight.yang.gen.v1.urn.opendaylight.bulk.flow.service.rev150608.bulk.flow.list.grouping
Class BulkFlowItemBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.bulk.flow.service.rev150608.bulk.flow.list.grouping.BulkFlowItemBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BulkFlowItem>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BulkFlowItem,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BulkFlowItemBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BulkFlowItem>
Class that buildsBulkFlowItem
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:
BulkFlowItem createBulkFlowItem(int fooXyzzy, int barBaz) { return new BulkFlowItemBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BulkFlowItem, 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:
BulkFlowItem
,Builder
-
-
Constructor Summary
Constructors Constructor Description BulkFlowItemBuilder()
BulkFlowItemBuilder(BulkFlowItem base)
BulkFlowItemBuilder(BulkFlowBaseContentGrouping arg)
BulkFlowItemBuilder(Flow arg)
BulkFlowItemBuilder(GenericFlowAttributes arg)
BulkFlowItemBuilder(NodeContextRef arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BulkFlowItemBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BulkFlowItem> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BulkFlowItem>>
E$$augmentation(Class<E$$> augmentationType)
BulkFlowItem
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()
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()
BulkFlowItemBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BulkFlowItem>> augmentationType)
Remove an augmentation from this builder's product.BulkFlowItemBuilder
setBarrier(Boolean value)
BulkFlowItemBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
BulkFlowItemBuilder
setContainerName(String value)
BulkFlowItemBuilder
setCookie(FlowCookie value)
BulkFlowItemBuilder
setCookieMask(FlowCookie value)
BulkFlowItemBuilder
setFlags(FlowModFlags value)
BulkFlowItemBuilder
setFlowName(String value)
BulkFlowItemBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
BulkFlowItemBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
BulkFlowItemBuilder
setInstallHw(Boolean value)
BulkFlowItemBuilder
setInstructions(Instructions value)
BulkFlowItemBuilder
setMatch(Match value)
BulkFlowItemBuilder
setNode(NodeRef value)
BulkFlowItemBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
BulkFlowItemBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
BulkFlowItemBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
BulkFlowItemBuilder
setStrict(Boolean value)
BulkFlowItemBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
BulkFlowItemBuilder
public BulkFlowItemBuilder()
-
BulkFlowItemBuilder
public BulkFlowItemBuilder(BulkFlowBaseContentGrouping arg)
-
BulkFlowItemBuilder
public BulkFlowItemBuilder(NodeContextRef arg)
-
BulkFlowItemBuilder
public BulkFlowItemBuilder(Flow arg)
-
BulkFlowItemBuilder
public BulkFlowItemBuilder(GenericFlowAttributes arg)
-
BulkFlowItemBuilder
public BulkFlowItemBuilder(BulkFlowItem 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()
-
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<BulkFlowItem>> E$$ augmentation(Class<E$$> augmentationType)
-
setBarrier
public BulkFlowItemBuilder setBarrier(Boolean value)
-
setBufferId
public BulkFlowItemBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setContainerName
public BulkFlowItemBuilder setContainerName(String value)
-
setCookie
public BulkFlowItemBuilder setCookie(FlowCookie value)
-
setCookieMask
public BulkFlowItemBuilder setCookieMask(FlowCookie value)
-
setFlags
public BulkFlowItemBuilder setFlags(FlowModFlags value)
-
setFlowName
public BulkFlowItemBuilder setFlowName(String value)
-
setHardTimeout
public BulkFlowItemBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
public BulkFlowItemBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setInstallHw
public BulkFlowItemBuilder setInstallHw(Boolean value)
-
setInstructions
public BulkFlowItemBuilder setInstructions(Instructions value)
-
setMatch
public BulkFlowItemBuilder setMatch(Match value)
-
setNode
public BulkFlowItemBuilder setNode(NodeRef value)
-
setOutGroup
public BulkFlowItemBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutPort
public BulkFlowItemBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setPriority
public BulkFlowItemBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setStrict
public BulkFlowItemBuilder setStrict(Boolean value)
-
setTableId
public BulkFlowItemBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
addAugmentation
public BulkFlowItemBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BulkFlowItem> 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 BulkFlowItemBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BulkFlowItem>> 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 BulkFlowItem build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BulkFlowItem>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BulkFlowItem,IllegalArgumentException>
-
-