org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.tun.ipv4.src.grouping

Class NxmNxTunIpv4SrcBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.tun.ipv4.src.grouping.NxmNxTunIpv4SrcBuilder

All Implemented Interfaces:

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

public class NxmNxTunIpv4SrcBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmNxTunIpv4Src>

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

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

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

NxmNxTunIpv4SrcBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmNxTunIpv4SrcBuilder()
NxmNxTunIpv4SrcBuilder(Ipv4AddressGrouping arg)
NxmNxTunIpv4SrcBuilder(NxmNxTunIpv4Src base)

Method Summary

Modifier and Type	Method and Description
NxmNxTunIpv4SrcBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunIpv4Src>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunIpv4Src> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunIpv4Src>> E$$	augmentation(Class<E$$> augmentationType)
NxmNxTunIpv4Src	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.inet.types.rev130715.Ipv4Address	getIpv4Address()
NxmNxTunIpv4SrcBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunIpv4Src>> augmentationType)
NxmNxTunIpv4SrcBuilder	setIpv4Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxmNxTunIpv4SrcBuilder

public NxmNxTunIpv4SrcBuilder()

NxmNxTunIpv4SrcBuilder

public NxmNxTunIpv4SrcBuilder(Ipv4AddressGrouping arg)

NxmNxTunIpv4SrcBuilder

public NxmNxTunIpv4SrcBuilder(NxmNxTunIpv4Src 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.Ipv4AddressGrouping

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getIpv4Address

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getIpv4Address()

augmentation

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

setIpv4Address

public NxmNxTunIpv4SrcBuilder setIpv4Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)

addAugmentation

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

removeAugmentation

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

build

public NxmNxTunIpv4Src build()

Specified by:

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