Package org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action

Class SetNextHopActionCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.SetNextHopActionCaseBuilder

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

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

   
     SetNextHopActionCase createSetNextHopActionCase(int fooXyzzy, int barBaz) {
         return new SetNextHopActionCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

SetNextHopActionCase

Constructor Summary

Constructors

Constructor	Description
SetNextHopActionCaseBuilder()	Construct an empty builder.
SetNextHopActionCaseBuilder(SetNextHopActionCase base)	Construct a builder initialized with state from specified SetNextHopActionCase.

Method Summary

Modifier and Type	Method	Description
SetNextHopActionCaseBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetNextHopActionCase> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNextHopActionCase>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull SetNextHopActionCase	build()	A new SetNextHopActionCase instance.
SetNextHopAction	getSetNextHopAction()	Return current value associated with the property corresponding to SetNextHopActionCase.getSetNextHopAction().
SetNextHopActionCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNextHopActionCase>> augmentationType)	Remove an augmentation from this builder's product.
SetNextHopActionCaseBuilder	setSetNextHopAction(SetNextHopAction value)	Set the property corresponding to SetNextHopActionCase.getSetNextHopAction() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

SetNextHopActionCaseBuilder

public SetNextHopActionCaseBuilder()

Construct an empty builder.

SetNextHopActionCaseBuilder

public SetNextHopActionCaseBuilder(SetNextHopActionCase base)

Construct a builder initialized with state from specified SetNextHopActionCase.

Parameters:

base - SetNextHopActionCase from which the builder should be initialized

Method Detail

getSetNextHopAction

public SetNextHopAction getSetNextHopAction()

Return current value associated with the property corresponding to SetNextHopActionCase.getSetNextHopAction().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNextHopActionCase>> 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

setSetNextHopAction

public SetNextHopActionCaseBuilder setSetNextHopAction(SetNextHopAction value)

Set the property corresponding to SetNextHopActionCase.getSetNextHopAction() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

public SetNextHopActionCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetNextHopActionCase> 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 SetNextHopActionCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNextHopActionCase>> 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 SetNextHopActionCase build()

A new SetNextHopActionCase instance.

Returns:

A new SetNextHopActionCase instance.