Class SetAsyncInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.SetAsyncInputBuilder
-
@Generated("mdsal-binding-generator") public class SetAsyncInputBuilder extends Object
Class that buildsSetAsyncInput
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:
SetAsyncInput createSetAsyncInput(int fooXyzzy, int barBaz) { return new SetAsyncInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SetAsyncInput, 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:
SetAsyncInput
- 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 SetAsyncInputBuilder()
Construct an empty builder.SetAsyncInputBuilder(AsyncBodyGrouping arg)
Construct a new builder initialized from specifiedAsyncBodyGrouping
.SetAsyncInputBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.SetAsyncInputBuilder(SetAsync$G arg)
Construct a new builder initialized from specifiedSetAsync$G
.SetAsyncInputBuilder(SetAsyncInput base)
Construct a builder initialized with state from specifiedSetAsyncInput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SetAsyncInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetAsyncInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetAsyncInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SetAsyncInput
build()
A newSetAsyncInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<FlowRemovedMask>
getFlowRemovedMask()
Return current value associated with the property corresponding toAsyncBodyGrouping.getFlowRemovedMask()
.List<PacketInMask>
getPacketInMask()
Return current value associated with the property corresponding toAsyncBodyGrouping.getPacketInMask()
.List<PortStatusMask>
getPortStatusMask()
Return current value associated with the property corresponding toAsyncBodyGrouping.getPortStatusMask()
.org.opendaylight.yangtools.yang.common.Uint8
getVersion()
Return current value associated with the property corresponding toOfHeader.getVersion()
.org.opendaylight.yangtools.yang.common.Uint32
getXid()
Return current value associated with the property corresponding toOfHeader.getXid()
.SetAsyncInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetAsyncInput>> augmentationType)
Remove an augmentation from this builder's product.SetAsyncInputBuilder
setFlowRemovedMask(List<FlowRemovedMask> values)
Set the property corresponding toAsyncBodyGrouping.getFlowRemovedMask()
to the specified value.SetAsyncInputBuilder
setPacketInMask(List<PacketInMask> values)
Set the property corresponding toAsyncBodyGrouping.getPacketInMask()
to the specified value.SetAsyncInputBuilder
setPortStatusMask(List<PortStatusMask> values)
Set the property corresponding toAsyncBodyGrouping.getPortStatusMask()
to the specified value.SetAsyncInputBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.SetAsyncInputBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.
-
-
-
Constructor Detail
-
SetAsyncInputBuilder
public SetAsyncInputBuilder()
Construct an empty builder.
-
SetAsyncInputBuilder
public SetAsyncInputBuilder(SetAsync$G arg)
Construct a new builder initialized from specifiedSetAsync$G
.- Parameters:
arg
- SetAsync$G from which the builder should be initialized
-
SetAsyncInputBuilder
public SetAsyncInputBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.- Parameters:
arg
- OfHeader from which the builder should be initialized
-
SetAsyncInputBuilder
public SetAsyncInputBuilder(AsyncBodyGrouping arg)
Construct a new builder initialized from specifiedAsyncBodyGrouping
.- Parameters:
arg
- AsyncBodyGrouping from which the builder should be initialized
-
SetAsyncInputBuilder
public SetAsyncInputBuilder(SetAsyncInput base)
Construct a builder initialized with state from specifiedSetAsyncInput
.- Parameters:
base
- SetAsyncInput 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
-
getFlowRemovedMask
public List<FlowRemovedMask> getFlowRemovedMask()
Return current value associated with the property corresponding toAsyncBodyGrouping.getFlowRemovedMask()
.- Returns:
- current value
-
getPacketInMask
public List<PacketInMask> getPacketInMask()
Return current value associated with the property corresponding toAsyncBodyGrouping.getPacketInMask()
.- Returns:
- current value
-
getPortStatusMask
public List<PortStatusMask> getPortStatusMask()
Return current value associated with the property corresponding toAsyncBodyGrouping.getPortStatusMask()
.- Returns:
- current value
-
getVersion
public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
Return current value associated with the property corresponding toOfHeader.getVersion()
.- Returns:
- current value
-
getXid
public org.opendaylight.yangtools.yang.common.Uint32 getXid()
Return current value associated with the property corresponding toOfHeader.getXid()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetAsyncInput>> 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
-
setFlowRemovedMask
public SetAsyncInputBuilder setFlowRemovedMask(List<FlowRemovedMask> values)
Set the property corresponding toAsyncBodyGrouping.getFlowRemovedMask()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setPacketInMask
public SetAsyncInputBuilder setPacketInMask(List<PacketInMask> values)
Set the property corresponding toAsyncBodyGrouping.getPacketInMask()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setPortStatusMask
public SetAsyncInputBuilder setPortStatusMask(List<PortStatusMask> values)
Set the property corresponding toAsyncBodyGrouping.getPortStatusMask()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setVersion
public SetAsyncInputBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXid
public SetAsyncInputBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SetAsyncInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetAsyncInput> 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 SetAsyncInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetAsyncInput>> 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 SetAsyncInput build()
A newSetAsyncInput
instance.- Returns:
- A new
SetAsyncInput
instance.
-
-