org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.arp.sha.grouping

Class NxmNxArpShaBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.arp.sha.grouping.NxmNxArpShaBuilder

All Implemented Interfaces:

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

public class NxmNxArpShaBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmNxArpSha>

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

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

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

NxmNxArpShaBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmNxArpShaBuilder()
NxmNxArpShaBuilder(MacAddressGrouping arg)
NxmNxArpShaBuilder(NxmNxArpSha base)

Method Summary

Modifier and Type	Method and Description
NxmNxArpShaBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxArpSha>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxArpSha> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxArpSha>> E$$	augmentation(Class<E$$> augmentationType)
NxmNxArpSha	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()
NxmNxArpShaBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxArpSha>> augmentationType)
NxmNxArpShaBuilder	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

NxmNxArpShaBuilder

public NxmNxArpShaBuilder()

NxmNxArpShaBuilder

public NxmNxArpShaBuilder(MacAddressGrouping arg)

NxmNxArpShaBuilder

public NxmNxArpShaBuilder(NxmNxArpSha 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<NxmNxArpSha>> E$$ augmentation(Class<E$$> augmentationType)

setMacAddress

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

addAugmentation

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

removeAugmentation

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

build

public NxmNxArpSha build()

Specified by:

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