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