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

Class FlowTableStatisticsBuilder

java.lang.Object

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

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<FlowTableStatistics>, org.opendaylight.yangtools.concepts.CheckedBuilder<FlowTableStatistics,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class FlowTableStatisticsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<FlowTableStatistics>

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

   
     FlowTableStatisticsBuilder createTarget(int fooXyzzy, int barBaz) {
         return new FlowTableStatisticsBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

FlowTableStatisticsBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
FlowTableStatisticsBuilder()
FlowTableStatisticsBuilder(FlowTableStatistics base)
FlowTableStatisticsBuilder(GenericTableStatistics arg)

Method Summary

Modifier and Type	Method and Description
FlowTableStatisticsBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowTableStatistics>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowTableStatistics> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowTableStatistics>> E$$	augmentation(Class<E$$> augmentationType)
FlowTableStatistics	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32	getActiveFlows()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64	getPacketsLookedUp()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64	getPacketsMatched()
FlowTableStatisticsBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowTableStatistics>> augmentationType)
FlowTableStatisticsBuilder	setActiveFlows(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
FlowTableStatisticsBuilder	setPacketsLookedUp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
FlowTableStatisticsBuilder	setPacketsMatched(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowTableStatisticsBuilder

public FlowTableStatisticsBuilder()

FlowTableStatisticsBuilder

public FlowTableStatisticsBuilder(GenericTableStatistics arg)

FlowTableStatisticsBuilder

public FlowTableStatisticsBuilder(FlowTableStatistics base)

Method Detail

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:

• org.opendaylight.yang.gen.v1.urn.opendaylight.model.statistics.types.rev130925.GenericTableStatistics

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getActiveFlows

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getActiveFlows()

getPacketsLookedUp

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketsLookedUp()

getPacketsMatched

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketsMatched()

augmentation

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

setActiveFlows

public FlowTableStatisticsBuilder setActiveFlows(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)

setPacketsLookedUp

public FlowTableStatisticsBuilder setPacketsLookedUp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)

setPacketsMatched

public FlowTableStatisticsBuilder setPacketsMatched(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)

addAugmentation

public FlowTableStatisticsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowTableStatistics>> augmentationType,
                                                  org.opendaylight.yangtools.yang.binding.Augmentation<FlowTableStatistics> augmentationValue)

removeAugmentation

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

build

public FlowTableStatistics build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<FlowTableStatistics,IllegalArgumentException>