org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.of.in.port.grouping

Class OfInPortBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.of.in.port.grouping.OfInPortBuilder

All Implemented Interfaces:

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

public class OfInPortBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<OfInPort>

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

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

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

OfInPortBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
OfInPortBuilder()
OfInPortBuilder(OfInPort base)

Method Summary

Modifier and Type	Method and Description
OfInPortBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OfInPort>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<OfInPort> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OfInPort>> E$$	augmentation(Class<E$$> augmentationType)
OfInPort	build()
Integer	getValue()
OfInPortBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OfInPort>> augmentationType)
OfInPortBuilder	setValue(Integer value)

Methods inherited from class java.lang.Object

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

Constructor Detail

OfInPortBuilder

public OfInPortBuilder()

OfInPortBuilder

public OfInPortBuilder(OfInPort base)

Method Detail

getValue

public Integer getValue()

augmentation

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

setValue

public OfInPortBuilder setValue(Integer value)

addAugmentation

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

removeAugmentation

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

build

public OfInPort build()

Specified by:

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