Class ExperimenterInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ExperimenterInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ExperimenterInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ExperimenterInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ExperimenterInput>
Class that buildsExperimenterInputBuilder
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:
ExperimenterInputBuilder createTarget(int fooXyzzy, int barBaz) { return new ExperimenterInputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ExperimenterInputBuilder, 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:
ExperimenterInputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ExperimenterInputBuilder()
ExperimenterInputBuilder(ExperimenterCore arg)
ExperimenterInputBuilder(ExperimenterInput base)
ExperimenterInputBuilder(ExperimenterOfMessage arg)
ExperimenterInputBuilder(OfHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ExperimenterInputBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterInput> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterInput>>
E$$augmentation(Class<E$$> augmentationType)
ExperimenterInput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ExperimenterId
getExperimenter()
ExperimenterDataOfChoice
getExperimenterDataOfChoice()
org.opendaylight.yangtools.yang.common.Uint32
getExpType()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
ExperimenterInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterInput>> augmentationType)
ExperimenterInputBuilder
setExperimenter(ExperimenterId value)
ExperimenterInputBuilder
setExperimenterDataOfChoice(ExperimenterDataOfChoice value)
ExperimenterInputBuilder
setExpType(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setExpType(Uint32)} instead.ExperimenterInputBuilder
setExpType(org.opendaylight.yangtools.yang.common.Uint32 value)
ExperimenterInputBuilder
setVersion(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVersion(Uint8)} instead.ExperimenterInputBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
ExperimenterInputBuilder
setXid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setXid(Uint32)} instead.ExperimenterInputBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
ExperimenterInputBuilder
public ExperimenterInputBuilder()
-
ExperimenterInputBuilder
public ExperimenterInputBuilder(ExperimenterOfMessage arg)
-
ExperimenterInputBuilder
public ExperimenterInputBuilder(OfHeader arg)
-
ExperimenterInputBuilder
public ExperimenterInputBuilder(ExperimenterCore arg)
-
ExperimenterInputBuilder
public ExperimenterInputBuilder(ExperimenterInput 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.openflow.protocol.rev130731.ExperimenterCore
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterOfMessage
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getExpType
public org.opendaylight.yangtools.yang.common.Uint32 getExpType()
-
getExperimenter
public ExperimenterId getExperimenter()
-
getExperimenterDataOfChoice
public ExperimenterDataOfChoice getExperimenterDataOfChoice()
-
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<ExperimenterInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setExpType
public ExperimenterInputBuilder setExpType(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setExpType
@Deprecated(forRemoval=true) public ExperimenterInputBuilder setExpType(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setExpType(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setExperimenter
public ExperimenterInputBuilder setExperimenter(ExperimenterId value)
-
setExperimenterDataOfChoice
public ExperimenterInputBuilder setExperimenterDataOfChoice(ExperimenterDataOfChoice value)
-
setVersion
public ExperimenterInputBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setVersion
@Deprecated(forRemoval=true) public ExperimenterInputBuilder setVersion(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVersion(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setXid
public ExperimenterInputBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setXid
@Deprecated(forRemoval=true) public ExperimenterInputBuilder setXid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setXid(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public ExperimenterInputBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterInput> augmentationValue)
-
removeAugmentation
public ExperimenterInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterInput>> augmentationType)
-
build
public ExperimenterInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ExperimenterInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ExperimenterInput,IllegalArgumentException>
-
-