org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice

Class WriteMetadataCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.WriteMetadataCaseBuilder

All Implemented Interfaces:

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

public class WriteMetadataCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<WriteMetadataCase>

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

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

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

WriteMetadataCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
WriteMetadataCaseBuilder()
WriteMetadataCaseBuilder(WriteMetadataCase base)

Method Summary

Modifier and Type	Method and Description
WriteMetadataCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadataCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadataCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadataCase>> E$$	augmentation(Class<E$$> augmentationType)
WriteMetadataCase	build()
WriteMetadata	getWriteMetadata()
WriteMetadataCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadataCase>> augmentationType)
WriteMetadataCaseBuilder	setWriteMetadata(WriteMetadata value)

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteMetadataCaseBuilder

public WriteMetadataCaseBuilder()

WriteMetadataCaseBuilder

public WriteMetadataCaseBuilder(WriteMetadataCase base)

Method Detail

getWriteMetadata

public WriteMetadata getWriteMetadata()

augmentation

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

setWriteMetadata

public WriteMetadataCaseBuilder setWriteMetadata(WriteMetadata value)

addAugmentation

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

removeAugmentation

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

build

public WriteMetadataCase build()

Specified by:

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