Class AsyncConfigMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.async.config.service.rev170619.AsyncConfigMessageBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AsyncConfigMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AsyncConfigMessage,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AsyncConfigMessageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<AsyncConfigMessage>
Class that buildsAsyncConfigMessage
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:
AsyncConfigMessage createAsyncConfigMessage(int fooXyzzy, int barBaz) { return new AsyncConfigMessageBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AsyncConfigMessage, 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:
AsyncConfigMessage
,Builder
-
-
Constructor Summary
Constructors Constructor Description AsyncConfigMessageBuilder()
AsyncConfigMessageBuilder(AsyncConfig arg)
AsyncConfigMessageBuilder(AsyncConfigMessage base)
AsyncConfigMessageBuilder(OfHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AsyncConfigMessageBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AsyncConfigMessage> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AsyncConfigMessage>>
E$$augmentation(Class<E$$> augmentationType)
AsyncConfigMessage
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.FlowRemovedMask
getFlowRemovedMask()
PacketInMask
getPacketInMask()
PortStatusMask
getPortStatusMask()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
AsyncConfigMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsyncConfigMessage>> augmentationType)
Remove an augmentation from this builder's product.AsyncConfigMessageBuilder
setFlowRemovedMask(FlowRemovedMask value)
AsyncConfigMessageBuilder
setPacketInMask(PacketInMask value)
AsyncConfigMessageBuilder
setPortStatusMask(PortStatusMask value)
AsyncConfigMessageBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
AsyncConfigMessageBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
AsyncConfigMessageBuilder
public AsyncConfigMessageBuilder()
-
AsyncConfigMessageBuilder
public AsyncConfigMessageBuilder(OfHeader arg)
-
AsyncConfigMessageBuilder
public AsyncConfigMessageBuilder(AsyncConfig arg)
-
AsyncConfigMessageBuilder
public AsyncConfigMessageBuilder(AsyncConfigMessage 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:- OfHeader
- AsyncConfig
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getFlowRemovedMask
public FlowRemovedMask getFlowRemovedMask()
-
getPacketInMask
public PacketInMask getPacketInMask()
-
getPortStatusMask
public PortStatusMask getPortStatusMask()
-
getVersion
public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
-
getXid
public org.opendaylight.yangtools.yang.common.Uint32 getXid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AsyncConfigMessage>> E$$ augmentation(Class<E$$> augmentationType)
-
setFlowRemovedMask
public AsyncConfigMessageBuilder setFlowRemovedMask(FlowRemovedMask value)
-
setPacketInMask
public AsyncConfigMessageBuilder setPacketInMask(PacketInMask value)
-
setPortStatusMask
public AsyncConfigMessageBuilder setPortStatusMask(PortStatusMask value)
-
setVersion
public AsyncConfigMessageBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setXid
public AsyncConfigMessageBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
addAugmentation
public AsyncConfigMessageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AsyncConfigMessage> 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 AsyncConfigMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AsyncConfigMessage>> 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 AsyncConfigMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AsyncConfigMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AsyncConfigMessage,IllegalArgumentException>
-
-