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