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

Class ApplyActionsBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class ApplyActionsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<ApplyActions>

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

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

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

ApplyActionsBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
ApplyActionsBuilder()
ApplyActionsBuilder(ActionList arg)
ApplyActionsBuilder(ApplyActions base)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplyActionsBuilder

public ApplyActionsBuilder()

ApplyActionsBuilder

public ApplyActionsBuilder(ActionList arg)

ApplyActionsBuilder

public ApplyActionsBuilder(ApplyActions 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<ApplyActions>> E$$ augmentation(Class<E$$> augmentationType)

setAction

public ApplyActionsBuilder setAction(List<Action> values)

addAugmentation

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

removeAugmentation

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

build

public ApplyActions build()

Specified by:

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