org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.ct.mark.grouping

Class NxmNxCtMarkBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.ct.mark.grouping.NxmNxCtMarkBuilder

All Implemented Interfaces:

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

public class NxmNxCtMarkBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmNxCtMark>

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

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

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

NxmNxCtMarkBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmNxCtMarkBuilder()
NxmNxCtMarkBuilder(NxmNxCtMark base)

Method Summary

Modifier and Type	Method and Description
NxmNxCtMarkBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtMark>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtMark> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtMark>> E$$	augmentation(Class<E$$> augmentationType)
NxmNxCtMark	build()
Long	getCtMark()
Long	getMask()
NxmNxCtMarkBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtMark>> augmentationType)
NxmNxCtMarkBuilder	setCtMark(Long value)
NxmNxCtMarkBuilder	setMask(Long value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxmNxCtMarkBuilder

public NxmNxCtMarkBuilder()

NxmNxCtMarkBuilder

public NxmNxCtMarkBuilder(NxmNxCtMark base)

Method Detail

getCtMark

public Long getCtMark()

getMask

public Long getMask()

augmentation

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

setCtMark

public NxmNxCtMarkBuilder setCtMark(Long value)

setMask

public NxmNxCtMarkBuilder setMask(Long value)

addAugmentation

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

removeAugmentation

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

build

public NxmNxCtMark build()

Specified by:

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