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

Class FlowStatisticsBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.flow.statistics.FlowStatisticsBuilder
@Generated("mdsal-binding-generator") public class FlowStatisticsBuilder extends Object
Class that builds FlowStatistics 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: 

   
     FlowStatistics createFlowStatistics(int fooXyzzy, int barBaz) {
         return new FlowStatisticsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

  • Constructor Details

    • FlowStatisticsBuilder

      public FlowStatisticsBuilder()
      Construct an empty builder.

    • FlowStatisticsBuilder

      public FlowStatisticsBuilder(GenericStatistics arg)
      Construct a new builder initialized from specified GenericStatistics.
      Parameters:
      arg - GenericStatistics from which the builder should be initialized

    • FlowStatisticsBuilder

      public FlowStatisticsBuilder(Duration arg)
      Construct a new builder initialized from specified Duration.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.model.statistics.types.rev130925.Duration from which the builder should be initialized

    • FlowStatisticsBuilder

      public FlowStatisticsBuilder(FlowStatistics base)
      Construct a builder initialized with state from specified FlowStatistics.
      Parameters:
      base - FlowStatistics 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:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • empty

      public static @NonNull FlowStatistics empty()
      Get empty instance of FlowStatistics.
      Returns:
      An empty FlowStatistics

    • getByteCount

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getByteCount()
      Return current value associated with the property corresponding to GenericStatistics.getByteCount().
      Returns:
      current value

    • getDuration

      public Duration getDuration()
      Return current value associated with the property corresponding to Duration.getDuration().
      Returns:
      current value

    • getPacketCount

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketCount()
      Return current value associated with the property corresponding to GenericStatistics.getPacketCount().
      Returns:
      current value

    • augmentation

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

    • setByteCount

      public FlowStatisticsBuilder setByteCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
      Set the property corresponding to GenericStatistics.getByteCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setDuration

      public FlowStatisticsBuilder setDuration(Duration value)
      Set the property corresponding to Duration.getDuration() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPacketCount

      public FlowStatisticsBuilder setPacketCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
      Set the property corresponding to GenericStatistics.getPacketCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public FlowStatisticsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowStatistics> 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 FlowStatisticsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowStatistics>> 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 FlowStatistics build()
      A new FlowStatistics instance.
      Returns:
      A new FlowStatistics instance.