Package org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314

Class RemoveFlowsBatchInputBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.RemoveFlowsBatchInputBuilder

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

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

   
     RemoveFlowsBatchInput createRemoveFlowsBatchInput(int fooXyzzy, int barBaz) {
         return new RemoveFlowsBatchInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• RemoveFlowsBatchInput

Constructor Summary

Constructors

Constructor	Description
RemoveFlowsBatchInputBuilder()	Construct an empty builder.
RemoveFlowsBatchInputBuilder(RemoveFlowsBatchInput base)	Construct a builder initialized with state from specified RemoveFlowsBatchInput.
RemoveFlowsBatchInputBuilder(NodeContextRef arg)	Construct a new builder initialized from specified NodeContextRef.
RemoveFlowsBatchInputBuilder(BarrierSuffix arg)	Construct a new builder initialized from specified BarrierSuffix.

Method Summary

Modifier and Type	Method	Description
RemoveFlowsBatchInputBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RemoveFlowsBatchInput> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoveFlowsBatchInput>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull RemoveFlowsBatchInput	build()	A new RemoveFlowsBatchInput instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
Boolean	getBarrierAfter()	Return current value associated with the property corresponding to BarrierSuffix.getBarrierAfter().
Map<BatchRemoveFlowsKey,BatchRemoveFlows>	getBatchRemoveFlows()	Return current value associated with the property corresponding to RemoveFlowsBatchInput.getBatchRemoveFlows().
NodeRef	getNode()	Return current value associated with the property corresponding to NodeContextRef.getNode().
RemoveFlowsBatchInputBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoveFlowsBatchInput>> augmentationType)	Remove an augmentation from this builder's product.
RemoveFlowsBatchInputBuilder	setBarrierAfter(Boolean value)	Set the property corresponding to BarrierSuffix.getBarrierAfter() to the specified value.
RemoveFlowsBatchInputBuilder	setBatchRemoveFlows(Map<BatchRemoveFlowsKey,BatchRemoveFlows> values)	Set the property corresponding to RemoveFlowsBatchInput.getBatchRemoveFlows() to the specified value.
RemoveFlowsBatchInputBuilder	setNode(NodeRef value)	Set the property corresponding to NodeContextRef.getNode() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

RemoveFlowsBatchInputBuilder

public RemoveFlowsBatchInputBuilder()

Construct an empty builder.

RemoveFlowsBatchInputBuilder

public RemoveFlowsBatchInputBuilder(NodeContextRef arg)

Construct a new builder initialized from specified NodeContextRef.

Parameters:

arg - NodeContextRef from which the builder should be initialized

RemoveFlowsBatchInputBuilder

public RemoveFlowsBatchInputBuilder(BarrierSuffix arg)

Construct a new builder initialized from specified BarrierSuffix.

Parameters:

arg - BarrierSuffix from which the builder should be initialized

RemoveFlowsBatchInputBuilder

public RemoveFlowsBatchInputBuilder(RemoveFlowsBatchInput base)

Construct a builder initialized with state from specified RemoveFlowsBatchInput.

Parameters:

base - RemoveFlowsBatchInput 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:

• NodeContextRef
• BarrierSuffix

Parameters:

arg - grouping object

Throws:

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

getBarrierAfter

public Boolean getBarrierAfter()

Return current value associated with the property corresponding to BarrierSuffix.getBarrierAfter().

Returns:

current value

getBatchRemoveFlows

public Map<BatchRemoveFlowsKey,BatchRemoveFlows> getBatchRemoveFlows()

Return current value associated with the property corresponding to RemoveFlowsBatchInput.getBatchRemoveFlows().

Returns:

current value

getNode

public NodeRef getNode()

Return current value associated with the property corresponding to NodeContextRef.getNode().

Returns:

current value

augmentation

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

setBarrierAfter

public RemoveFlowsBatchInputBuilder setBarrierAfter(Boolean value)

Set the property corresponding to BarrierSuffix.getBarrierAfter() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setBatchRemoveFlows

public RemoveFlowsBatchInputBuilder setBatchRemoveFlows(Map<BatchRemoveFlowsKey,BatchRemoveFlows> values)

Set the property corresponding to RemoveFlowsBatchInput.getBatchRemoveFlows() to the specified value.

Parameters:

values - desired value

Returns:

this builder

setNode

public RemoveFlowsBatchInputBuilder setNode(NodeRef value)

Set the property corresponding to NodeContextRef.getNode() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new RemoveFlowsBatchInput instance.

Returns:

A new RemoveFlowsBatchInput instance.