org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.of.eth.src.grouping

Class NxmOfEthSrcBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.of.eth.src.grouping.NxmOfEthSrcBuilder

All Implemented Interfaces:

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

public class NxmOfEthSrcBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmOfEthSrc>

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

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

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

NxmOfEthSrcBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmOfEthSrcBuilder()
NxmOfEthSrcBuilder(MacAddressGrouping arg)
NxmOfEthSrcBuilder(NxmOfEthSrc base)

Method Summary

Modifier and Type	Method and Description
NxmOfEthSrcBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfEthSrc>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfEthSrc> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfEthSrc>> E$$	augmentation(Class<E$$> augmentationType)
NxmOfEthSrc	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress	getMacAddress()
NxmOfEthSrcBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfEthSrc>> augmentationType)
NxmOfEthSrcBuilder	setMacAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxmOfEthSrcBuilder

public NxmOfEthSrcBuilder()

NxmOfEthSrcBuilder

public NxmOfEthSrcBuilder(MacAddressGrouping arg)

NxmOfEthSrcBuilder

public NxmOfEthSrcBuilder(NxmOfEthSrc 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.match.rev140714.MacAddressGrouping

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getMacAddress

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getMacAddress()

augmentation

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

setMacAddress

public NxmOfEthSrcBuilder setMacAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)

addAugmentation

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

removeAugmentation

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

build

public NxmOfEthSrc build()

Specified by:

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