Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210._if.indexes.tunnel.map

Class IfIndexTunnelBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210._if.indexes.tunnel.map.IfIndexTunnelBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<IfIndexTunnel>, org.opendaylight.yangtools.concepts.CheckedBuilder<IfIndexTunnel,java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class IfIndexTunnelBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<IfIndexTunnel>

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

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

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

IfIndexTunnelBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
IfIndexTunnelBuilder()
IfIndexTunnelBuilder(IfIndexTunnel base)

Method Summary

Modifier and Type	Method	Description
IfIndexTunnelBuilder	addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexTunnel>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexTunnel> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexTunnel>> E$$	augmentation(java.lang.Class<E$$> augmentationType)
IfIndexTunnel	build()
java.lang.Integer	getIfIndex()
java.lang.String	getInterfaceName()
IfIndexTunnelKey	key()
IfIndexTunnelBuilder	removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexTunnel>> augmentationType)
IfIndexTunnelBuilder	setIfIndex(java.lang.Integer value)
IfIndexTunnelBuilder	setInterfaceName(java.lang.String value)
IfIndexTunnelBuilder	withKey(IfIndexTunnelKey key)

Methods inherited from class java.lang.Object

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

Constructor Detail

IfIndexTunnelBuilder

public IfIndexTunnelBuilder()

IfIndexTunnelBuilder

public IfIndexTunnelBuilder(IfIndexTunnel base)

Method Detail

key

public IfIndexTunnelKey key()

getIfIndex

public java.lang.Integer getIfIndex()

getInterfaceName

public java.lang.String getInterfaceName()

augmentation

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

withKey

public IfIndexTunnelBuilder withKey(IfIndexTunnelKey key)

setIfIndex

public IfIndexTunnelBuilder setIfIndex(java.lang.Integer value)

setInterfaceName

public IfIndexTunnelBuilder setInterfaceName(java.lang.String value)

addAugmentation

public IfIndexTunnelBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexTunnel>> augmentationType,
                                            org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexTunnel> augmentationValue)

removeAugmentation

public IfIndexTunnelBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexTunnel>> augmentationType)

build

public IfIndexTunnel build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.Builder<IfIndexTunnel>

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<IfIndexTunnel,java.lang.IllegalArgumentException>