org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.push.mpls.action._case

Class PushMplsActionBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.push.mpls.action._case.PushMplsActionBuilder

All Implemented Interfaces:

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

public class PushMplsActionBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<PushMplsAction>

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

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

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

PushMplsActionBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PushMplsActionBuilder()
PushMplsActionBuilder(PushMplsAction base)

Method Summary

Modifier and Type	Method and Description
PushMplsActionBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PushMplsAction>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PushMplsAction> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PushMplsAction>> E$$	augmentation(Class<E$$> augmentationType)
PushMplsAction	build()
Integer	getEthernetType()
PushMplsActionBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PushMplsAction>> augmentationType)
PushMplsActionBuilder	setEthernetType(Integer value)

Methods inherited from class java.lang.Object

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

Constructor Detail

PushMplsActionBuilder

public PushMplsActionBuilder()

PushMplsActionBuilder

public PushMplsActionBuilder(PushMplsAction base)

Method Detail

getEthernetType

public Integer getEthernetType()

augmentation

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

setEthernetType

public PushMplsActionBuilder setEthernetType(Integer value)

addAugmentation

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

removeAugmentation

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

build

public PushMplsAction build()

Specified by:

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