org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.clear.actions._case

Class ClearActionsBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.clear.actions._case.ClearActionsBuilder

All Implemented Interfaces:

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

public class ClearActionsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<ClearActions>

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

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

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

ClearActionsBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
ClearActionsBuilder()
ClearActionsBuilder(ActionList arg)
ClearActionsBuilder(ClearActions base)

Method Summary

Modifier and Type	Method and Description
ClearActionsBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ClearActions>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ClearActions> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ClearActions>> E$$	augmentation(Class<E$$> augmentationType)
ClearActions	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
List<Action>	getAction()
ClearActionsBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ClearActions>> augmentationType)
ClearActionsBuilder	setAction(List<Action> values)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClearActionsBuilder

public ClearActionsBuilder()

ClearActionsBuilder

public ClearActionsBuilder(ActionList arg)

ClearActionsBuilder

public ClearActionsBuilder(ClearActions 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.action.types.rev131112.ActionList

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getAction

public List<Action> getAction()

augmentation

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

setAction

public ClearActionsBuilder setAction(List<Action> values)

addAugmentation

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

removeAugmentation

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

build

public ClearActions build()

Specified by:

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