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