org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731

Class SetConfigInputBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.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 builds SetConfigInputBuilder 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 and Description
SetConfigInputBuilder()
SetConfigInputBuilder(OfHeader arg)
SetConfigInputBuilder(SetConfig arg)
SetConfigInputBuilder(SetConfigInput base)

Method Summary

Modifier and Type	Method and 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.
SwitchConfigFlag	getFlags()
Integer	getMissSendLen()
Short	getVersion()
Long	getXid()
SetConfigInputBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput>> augmentationType)
SetConfigInputBuilder	setFlags(SwitchConfigFlag value)
SetConfigInputBuilder	setMissSendLen(Integer value)
SetConfigInputBuilder	setVersion(Short value)
SetConfigInputBuilder	setXid(Long value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SetConfigInputBuilder

public SetConfigInputBuilder()

SetConfigInputBuilder

public SetConfigInputBuilder(SetConfig arg)

SetConfigInputBuilder

public SetConfigInputBuilder(OfHeader 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.openflow.protocol.rev130731.OfHeader
• org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.SetConfig

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getFlags

public SwitchConfigFlag getFlags()

getMissSendLen

public Integer getMissSendLen()

getVersion

public Short getVersion()

getXid

public Long getXid()

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetConfigInput>> E$$ augmentation(Class<E$$> augmentationType)

setFlags

public SetConfigInputBuilder setFlags(SwitchConfigFlag value)

setMissSendLen

public SetConfigInputBuilder setMissSendLen(Integer value)

setVersion

public SetConfigInputBuilder setVersion(Short value)

setXid

public SetConfigInputBuilder setXid(Long 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 interface org.opendaylight.yangtools.concepts.CheckedBuilder<SetConfigInput,IllegalArgumentException>