org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map

Class IfIndexInterfaceBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterfaceBuilder

All Implemented Interfaces:

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

public class IfIndexInterfaceBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<IfIndexInterface>

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

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

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

IfIndexInterfaceBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
IfIndexInterfaceBuilder()
IfIndexInterfaceBuilder(IfIndexInterface base)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IfIndexInterfaceBuilder

public IfIndexInterfaceBuilder()

IfIndexInterfaceBuilder

public IfIndexInterfaceBuilder(IfIndexInterface base)

Method Detail

key

public IfIndexInterfaceKey key()

getIfIndex

public Integer getIfIndex()

getInterfaceName

public String getInterfaceName()

augmentation

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

withKey

public IfIndexInterfaceBuilder withKey(IfIndexInterfaceKey key)

setIfIndex

public IfIndexInterfaceBuilder setIfIndex(Integer value)

setInterfaceName

public IfIndexInterfaceBuilder setInterfaceName(String value)

addAugmentation

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

removeAugmentation

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

build

public IfIndexInterface build()

Specified by:

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