org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.controller.action._case

Class ControllerActionBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.controller.action._case.ControllerActionBuilder

All Implemented Interfaces:

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

public class ControllerActionBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<ControllerAction>

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

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

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

ControllerActionBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
ControllerActionBuilder()
ControllerActionBuilder(ControllerAction base)

Method Summary

Modifier and Type	Method and Description
ControllerActionBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerAction>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ControllerAction> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerAction>> E$$	augmentation(Class<E$$> augmentationType)
ControllerAction	build()
Integer	getMaxLength()
ControllerActionBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerAction>> augmentationType)
ControllerActionBuilder	setMaxLength(Integer value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ControllerActionBuilder

public ControllerActionBuilder()

ControllerActionBuilder

public ControllerActionBuilder(ControllerAction base)

Method Detail

getMaxLength

public Integer getMaxLength()

augmentation

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

setMaxLength

public ControllerActionBuilder setMaxLength(Integer value)

addAugmentation

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

removeAugmentation

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

build

public ControllerAction build()

Specified by:

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