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

Class PacketOutOutputBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class PacketOutOutputBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<PacketOutOutput>

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

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

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

PacketOutOutputBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PacketOutOutputBuilder()
PacketOutOutputBuilder(PacketOutOutput base)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PacketOutOutputBuilder

public PacketOutOutputBuilder()

PacketOutOutputBuilder

public PacketOutOutputBuilder(PacketOutOutput base)

Method Detail

augmentation

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

addAugmentation

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

removeAugmentation

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

build

public PacketOutOutput build()

Specified by:

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