org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.reg.load.grouping.nx.reg.load

Class DstBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.reg.load.grouping.nx.reg.load.DstBuilder

All Implemented Interfaces:

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

public class DstBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Dst>

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

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

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

DstBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
DstBuilder()
DstBuilder(Dst base)
DstBuilder(DstChoiceGrouping arg)
DstBuilder(RangeGrouping arg)

Method Summary

Modifier and Type	Method and Description
DstBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Dst>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Dst> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Dst>> E$$	augmentation(Class<E$$> augmentationType)
Dst	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
DstChoice	getDstChoice()
Integer	getEnd()
Integer	getStart()
DstBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Dst>> augmentationType)
DstBuilder	setDstChoice(DstChoice value)
DstBuilder	setEnd(Integer value)
DstBuilder	setStart(Integer value)

Methods inherited from class java.lang.Object

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

Constructor Detail

DstBuilder

public DstBuilder()

DstBuilder

public DstBuilder(DstChoiceGrouping arg)

DstBuilder

public DstBuilder(RangeGrouping arg)

DstBuilder

public DstBuilder(Dst 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.action.rev140714.RangeGrouping
• org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.DstChoiceGrouping

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getDstChoice

public DstChoice getDstChoice()

getEnd

public Integer getEnd()

getStart

public Integer getStart()

augmentation

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

setDstChoice

public DstBuilder setDstChoice(DstChoice value)

setEnd

public DstBuilder setEnd(Integer value)

setStart

public DstBuilder setStart(Integer value)

addAugmentation

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

removeAugmentation

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

build

public Dst build()

Specified by:

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