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

Class FloodActionBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.flood.action._case.FloodActionBuilder

All Implemented Interfaces:

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

public class FloodActionBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<FloodAction>

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

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

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

FloodActionBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
FloodActionBuilder()
FloodActionBuilder(FloodAction base)

Method Summary

Modifier and Type	Method and Description
FloodActionBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FloodAction>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FloodAction> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FloodAction>> E$$	augmentation(Class<E$$> augmentationType)
FloodAction	build()
FloodActionBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FloodAction>> augmentationType)

Methods inherited from class java.lang.Object

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

Constructor Detail

FloodActionBuilder

public FloodActionBuilder()

FloodActionBuilder

public FloodActionBuilder(FloodAction base)

Method Detail

augmentation

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

addAugmentation

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

removeAugmentation

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

build

public FloodAction build()

Specified by:

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