Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.remove.group.input.buckets.bucket.action.action

Class NxActionEncapRpcRemoveGroupCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.remove.group.input.buckets.bucket.action.action.NxActionEncapRpcRemoveGroupCaseBuilder

@Generated("mdsal-binding-generator")
public class NxActionEncapRpcRemoveGroupCaseBuilder
extends Object

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

   
     NxActionEncapRpcRemoveGroupCase createNxActionEncapRpcRemoveGroupCase(int fooXyzzy, int barBaz) {
         return new NxActionEncapRpcRemoveGroupCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• NxActionEncapRpcRemoveGroupCase

Constructor Summary

Constructors

Constructor	Description
NxActionEncapRpcRemoveGroupCaseBuilder()	Construct an empty builder.
NxActionEncapRpcRemoveGroupCaseBuilder(NxActionEncapGrouping arg)	Construct a new builder initialized from specified NxActionEncapGrouping.
NxActionEncapRpcRemoveGroupCaseBuilder(NxActionEncapRpcRemoveGroupCase base)	Construct a builder initialized with state from specified NxActionEncapRpcRemoveGroupCase.

Method Summary

Modifier and Type	Method	Description
NxActionEncapRpcRemoveGroupCaseBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncapRpcRemoveGroupCase> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncapRpcRemoveGroupCase>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull NxActionEncapRpcRemoveGroupCase	build()	A new NxActionEncapRpcRemoveGroupCase instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
NxEncap	getNxEncap()	Return current value associated with the property corresponding to NxActionEncapGrouping.getNxEncap().
NxActionEncapRpcRemoveGroupCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncapRpcRemoveGroupCase>> augmentationType)	Remove an augmentation from this builder's product.
NxActionEncapRpcRemoveGroupCaseBuilder	setNxEncap(NxEncap value)	Set the property corresponding to NxActionEncapGrouping.getNxEncap() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

NxActionEncapRpcRemoveGroupCaseBuilder

public NxActionEncapRpcRemoveGroupCaseBuilder()

Construct an empty builder.

NxActionEncapRpcRemoveGroupCaseBuilder

public NxActionEncapRpcRemoveGroupCaseBuilder(NxActionEncapGrouping arg)

Construct a new builder initialized from specified NxActionEncapGrouping.

Parameters:

arg - NxActionEncapGrouping from which the builder should be initialized

NxActionEncapRpcRemoveGroupCaseBuilder

public NxActionEncapRpcRemoveGroupCaseBuilder(NxActionEncapRpcRemoveGroupCase base)

Construct a builder initialized with state from specified NxActionEncapRpcRemoveGroupCase.

Parameters:

base - NxActionEncapRpcRemoveGroupCase from which the builder should be initialized

Method Details

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:

• NxActionEncapGrouping

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

getNxEncap

public NxEncap getNxEncap()

Return current value associated with the property corresponding to NxActionEncapGrouping.getNxEncap().

Returns:

current value

augmentation

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

Return the specified augmentation, if it is present in this builder.

Type Parameters:

E$$ - augmentation type

Parameters:

augmentationType - augmentation type class

Returns:

Augmentation object from this builder, or null if not present

Throws:

NullPointerException - if augmentType is null

setNxEncap

public NxActionEncapRpcRemoveGroupCaseBuilder setNxEncap(NxEncap value)

Set the property corresponding to NxActionEncapGrouping.getNxEncap() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

public NxActionEncapRpcRemoveGroupCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncapRpcRemoveGroupCase> augmentation)

Add an augmentation to this builder's product.

Parameters:

augmentation - augmentation to be added

Returns:

this builder

Throws:

NullPointerException - if augmentation is null

removeAugmentation

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

Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.

Parameters:

augmentationType - augmentation type to be removed

Returns:

this builder

build

public @NonNull NxActionEncapRpcRemoveGroupCase build()

A new NxActionEncapRpcRemoveGroupCase instance.

Returns:

A new NxActionEncapRpcRemoveGroupCase instance.