Class SetConfigInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.SetConfigInputBuilder
-
@Generated("mdsal-binding-generator") public class SetConfigInputBuilder extends Object
Class that buildsSetConfigInput
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:
SetConfigInput createSetConfigInput(int fooXyzzy, int barBaz) { return new SetConfigInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SetConfigInput, 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:
SetConfigInput
- 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 SetConfigInputBuilder()
Construct an empty builder.SetConfigInputBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.SetConfigInputBuilder(SetConfig$G arg)
Construct a new builder initialized from specifiedSetConfig$G
.SetConfigInputBuilder(SetConfigInput base)
Construct a builder initialized with state from specifiedSetConfigInput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SetConfigInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SetConfigInput
build()
A newSetConfigInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.SwitchConfigFlag
getFlags()
Return current value associated with the property corresponding toSetConfig$G.getFlags()
.org.opendaylight.yangtools.yang.common.Uint16
getMissSendLen()
Return current value associated with the property corresponding toSetConfig$G.getMissSendLen()
.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()
.SetConfigInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput>> augmentationType)
Remove an augmentation from this builder's product.SetConfigInputBuilder
setFlags(SwitchConfigFlag value)
Set the property corresponding toSetConfig$G.getFlags()
to the specified value.SetConfigInputBuilder
setMissSendLen(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toSetConfig$G.getMissSendLen()
to the specified value.SetConfigInputBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.SetConfigInputBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.
-
-
-
Constructor Detail
-
SetConfigInputBuilder
public SetConfigInputBuilder()
Construct an empty builder.
-
SetConfigInputBuilder
public SetConfigInputBuilder(SetConfig$G arg)
Construct a new builder initialized from specifiedSetConfig$G
.- Parameters:
arg
- SetConfig$G from which the builder should be initialized
-
SetConfigInputBuilder
public SetConfigInputBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.- Parameters:
arg
- OfHeader from which the builder should be initialized
-
SetConfigInputBuilder
public SetConfigInputBuilder(SetConfigInput base)
Construct a builder initialized with state from specifiedSetConfigInput
.- Parameters:
base
- SetConfigInput 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
-
getFlags
public SwitchConfigFlag getFlags()
Return current value associated with the property corresponding toSetConfig$G.getFlags()
.- Returns:
- current value
-
getMissSendLen
public org.opendaylight.yangtools.yang.common.Uint16 getMissSendLen()
Return current value associated with the property corresponding toSetConfig$G.getMissSendLen()
.- 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<SetConfigInput>> 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
-
setFlags
public SetConfigInputBuilder setFlags(SwitchConfigFlag value)
Set the property corresponding toSetConfig$G.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMissSendLen
public SetConfigInputBuilder setMissSendLen(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toSetConfig$G.getMissSendLen()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
public SetConfigInputBuilder 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 SetConfigInputBuilder 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 SetConfigInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput> 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 SetConfigInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput>> 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 SetConfigInput build()
A newSetConfigInput
instance.- Returns:
- A new
SetConfigInput
instance.
-
-