Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819

Class FlowStatisticsDataBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.FlowStatisticsDataBuilder

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

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

   
     FlowStatisticsData createFlowStatisticsData(int fooXyzzy, int barBaz) {
         return new FlowStatisticsDataBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• FlowStatisticsData

Constructor Summary

Constructors

Constructor	Description
FlowStatisticsDataBuilder()	Construct an empty builder.
FlowStatisticsDataBuilder(FlowStatistics arg)	Construct a new builder initialized from specified FlowStatistics.
FlowStatisticsDataBuilder(FlowStatisticsData base)	Construct a builder initialized with state from specified FlowStatisticsData.

Method Summary

Modifier and Type	Method	Description
@NonNull FlowStatisticsData	build()	A new FlowStatisticsData instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
FlowStatistics	getFlowStatistics()	Return current value associated with the property corresponding to FlowStatistics.getFlowStatistics().
FlowStatisticsDataBuilder	setFlowStatistics(FlowStatistics value)	Set the property corresponding to FlowStatistics.getFlowStatistics() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

FlowStatisticsDataBuilder

public FlowStatisticsDataBuilder()

Construct an empty builder.

FlowStatisticsDataBuilder

public FlowStatisticsDataBuilder(FlowStatistics arg)

Construct a new builder initialized from specified FlowStatistics.

Parameters:

arg - org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.FlowStatistics from which the builder should be initialized

FlowStatisticsDataBuilder

public FlowStatisticsDataBuilder(FlowStatisticsData base)

Construct a builder initialized with state from specified FlowStatisticsData.

Parameters:

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

• FlowStatistics

Parameters:

arg - grouping object

Throws:

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

getFlowStatistics

public FlowStatistics getFlowStatistics()

Return current value associated with the property corresponding to FlowStatistics.getFlowStatistics().

Returns:

current value

setFlowStatistics

public FlowStatisticsDataBuilder setFlowStatistics(FlowStatistics value)

Set the property corresponding to FlowStatistics.getFlowStatistics() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull FlowStatisticsData build()

A new FlowStatisticsData instance.

Returns:

A new FlowStatisticsData instance.