Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215

Class GetFlowTablesStatisticsInputBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.GetFlowTablesStatisticsInputBuilder

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

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

   
     GetFlowTablesStatisticsInput createGetFlowTablesStatisticsInput(int fooXyzzy, int barBaz) {
         return new GetFlowTablesStatisticsInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• GetFlowTablesStatisticsInput

Constructor Summary

Constructors

Constructor	Description
GetFlowTablesStatisticsInputBuilder()	Construct an empty builder.
GetFlowTablesStatisticsInputBuilder(GetFlowTablesStatisticsInput base)	Construct a builder initialized with state from specified GetFlowTablesStatisticsInput.
GetFlowTablesStatisticsInputBuilder(NodeContextRef arg)	Construct a new builder initialized from specified NodeContextRef.

Method Summary

Modifier and Type	Method	Description
GetFlowTablesStatisticsInputBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GetFlowTablesStatisticsInput> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetFlowTablesStatisticsInput>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull GetFlowTablesStatisticsInput	build()	A new GetFlowTablesStatisticsInput instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
NodeRef	getNode()	Return current value associated with the property corresponding to NodeContextRef.getNode().
GetFlowTablesStatisticsInputBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetFlowTablesStatisticsInput>> augmentationType)	Remove an augmentation from this builder's product.
GetFlowTablesStatisticsInputBuilder	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

GetFlowTablesStatisticsInputBuilder

public GetFlowTablesStatisticsInputBuilder()

Construct an empty builder.

GetFlowTablesStatisticsInputBuilder

public GetFlowTablesStatisticsInputBuilder(NodeContextRef arg)

Construct a new builder initialized from specified NodeContextRef.

Parameters:

arg - NodeContextRef from which the builder should be initialized

GetFlowTablesStatisticsInputBuilder

public GetFlowTablesStatisticsInputBuilder(GetFlowTablesStatisticsInput base)

Construct a builder initialized with state from specified GetFlowTablesStatisticsInput.

Parameters:

base - GetFlowTablesStatisticsInput 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

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types or has property with incompatible 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<GetFlowTablesStatisticsInput>>
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

setNode

public GetFlowTablesStatisticsInputBuilder setNode(NodeRef value)

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

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new GetFlowTablesStatisticsInput instance.

Returns:

A new GetFlowTablesStatisticsInput instance.