org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.action.container.action.choice.experimenter.id._case

Class ExperimenterBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.action.container.action.choice.experimenter.id._case.ExperimenterBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<Experimenter>, org.opendaylight.yangtools.concepts.CheckedBuilder<Experimenter,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class ExperimenterBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Experimenter>

Class that builds ExperimenterBuilder 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:

   
     ExperimenterBuilder createTarget(int fooXyzzy, int barBaz) {
         return new ExperimenterBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of ExperimenterBuilder, 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:

ExperimenterBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
ExperimenterBuilder()
ExperimenterBuilder(Experimenter base)

Method Summary

Modifier and Type	Method and Description
ExperimenterBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Experimenter>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Experimenter> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Experimenter>> E$$	augmentation(Class<E$$> augmentationType)
Experimenter	build()
ExperimenterId	getExperimenter()
Class<? extends ExperimenterActionSubType>	getSubType()
ExperimenterBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Experimenter>> augmentationType)
ExperimenterBuilder	setExperimenter(ExperimenterId value)
ExperimenterBuilder	setSubType(Class<? extends ExperimenterActionSubType> value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExperimenterBuilder

public ExperimenterBuilder()

ExperimenterBuilder

public ExperimenterBuilder(Experimenter base)

Method Detail

getExperimenter

public ExperimenterId getExperimenter()

getSubType

public Class<? extends ExperimenterActionSubType> getSubType()

augmentation

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

setExperimenter

public ExperimenterBuilder setExperimenter(ExperimenterId value)

setSubType

public ExperimenterBuilder setSubType(Class<? extends ExperimenterActionSubType> value)

addAugmentation

public ExperimenterBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Experimenter>> augmentationType,
                                           org.opendaylight.yangtools.yang.binding.Augmentation<Experimenter> augmentationValue)

removeAugmentation

public ExperimenterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Experimenter>> augmentationType)

build

public Experimenter build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Experimenter,IllegalArgumentException>