org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.dst.choice.grouping.dst.choice

Class DstOfMetadataCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.dst.choice.grouping.dst.choice.DstOfMetadataCaseBuilder

All Implemented Interfaces:

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

public class DstOfMetadataCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<DstOfMetadataCase>

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

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

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

DstOfMetadataCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
DstOfMetadataCaseBuilder()
DstOfMetadataCaseBuilder(DstOfMetadataCase base)
DstOfMetadataCaseBuilder(OxmOfMetadataGrouping arg)

Method Summary

Modifier and Type	Method and Description
DstOfMetadataCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DstOfMetadataCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DstOfMetadataCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DstOfMetadataCase>> E$$	augmentation(Class<E$$> augmentationType)
DstOfMetadataCase	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
org.opendaylight.yangtools.yang.common.Empty	getOfMetadata()
DstOfMetadataCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DstOfMetadataCase>> augmentationType)
DstOfMetadataCaseBuilder	setOfMetadata(org.opendaylight.yangtools.yang.common.Empty value)

Methods inherited from class java.lang.Object

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

Constructor Detail

DstOfMetadataCaseBuilder

public DstOfMetadataCaseBuilder()

DstOfMetadataCaseBuilder

public DstOfMetadataCaseBuilder(OxmOfMetadataGrouping arg)

DstOfMetadataCaseBuilder

public DstOfMetadataCaseBuilder(DstOfMetadataCase base)

Method Detail

fieldsFrom

public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)

Set fields from given grouping argument. Valid argument is instance of one of following types:

• org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.OxmOfMetadataGrouping

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getOfMetadata

public org.opendaylight.yangtools.yang.common.Empty getOfMetadata()

augmentation

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

setOfMetadata

public DstOfMetadataCaseBuilder setOfMetadata(org.opendaylight.yangtools.yang.common.Empty value)

addAugmentation

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

removeAugmentation

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

build

public DstOfMetadataCase build()

Specified by:

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