Class SetConfigInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.module.config.rev141015.SetConfigInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SetConfigInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SetConfigInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class SetConfigInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SetConfigInput>
Class that buildsSetConfigInputBuilder
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:
SetConfigInputBuilder createTarget(int fooXyzzy, int barBaz) { return new SetConfigInputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SetConfigInputBuilder, 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 oportunities, 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:
SetConfigInputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SetConfigInputBuilder()
SetConfigInputBuilder(TransactionAware arg)
SetConfigInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
SetConfigInputBuilder(NodeConfig arg)
SetConfigInputBuilder(SetConfigInput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SetConfigInputBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput>>
E$$augmentation(Class<E$$> augmentationType)
SetConfigInput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getFlag()
org.opendaylight.yangtools.yang.common.Uint16
getMissSearchLength()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef
getNode()
TransactionId
getTransactionId()
SetConfigInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput>> augmentationType)
SetConfigInputBuilder
setFlag(String value)
SetConfigInputBuilder
setMissSearchLength(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMissSearchLength(Uint16)} instead.SetConfigInputBuilder
setMissSearchLength(org.opendaylight.yangtools.yang.common.Uint16 value)
SetConfigInputBuilder
setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
SetConfigInputBuilder
setTransactionId(TransactionId value)
-
-
-
Constructor Detail
-
SetConfigInputBuilder
public SetConfigInputBuilder()
-
SetConfigInputBuilder
public SetConfigInputBuilder(NodeConfig arg)
-
SetConfigInputBuilder
public SetConfigInputBuilder(TransactionAware arg)
-
SetConfigInputBuilder
public SetConfigInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
-
SetConfigInputBuilder
public SetConfigInputBuilder(SetConfigInput 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionAware
- org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef
- org.opendaylight.yang.gen.v1.urn.opendaylight.module.config.rev141015.NodeConfig
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getFlag
public String getFlag()
-
getMissSearchLength
public org.opendaylight.yangtools.yang.common.Uint16 getMissSearchLength()
-
getNode
public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef getNode()
-
getTransactionId
public TransactionId getTransactionId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setFlag
public SetConfigInputBuilder setFlag(String value)
-
setMissSearchLength
public SetConfigInputBuilder setMissSearchLength(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMissSearchLength
@Deprecated(forRemoval=true) public SetConfigInputBuilder setMissSearchLength(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMissSearchLength(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setNode
public SetConfigInputBuilder setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
-
setTransactionId
public SetConfigInputBuilder setTransactionId(TransactionId value)
-
addAugmentation
public SetConfigInputBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput> augmentationValue)
-
removeAugmentation
public SetConfigInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput>> augmentationType)
-
build
public SetConfigInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SetConfigInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SetConfigInput,IllegalArgumentException>
-
-