Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120

Class StatsReportsMessageBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.StatsReportsMessageBuilder
@Generated("mdsal-binding-generator") public class StatsReportsMessageBuilder extends Object
Class that builds StatsReportsMessage 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: 

   
     StatsReportsMessage createStatsReportsMessage(int fooXyzzy, int barBaz) {
         return new StatsReportsMessageBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • StatsReportsMessageBuilder

      public StatsReportsMessageBuilder()
      Construct an empty builder.

    • StatsReportsMessageBuilder

      public StatsReportsMessageBuilder(PeerHeader arg)
      Construct a new builder initialized from specified PeerHeader.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.PeerHeader from which the builder should be initialized

    • StatsReportsMessageBuilder

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

    • StatsReportsMessageBuilder

      public StatsReportsMessageBuilder(StatsReportsMessage base)
      Construct a builder initialized with state from specified StatsReportsMessage.
      Parameters:
      base - StatsReportsMessage 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

    • getPeerHeader

      public PeerHeader getPeerHeader()
      Return current value associated with the property corresponding to PeerHeader.getPeerHeader().
      Returns:
      current value

    • getTlvs

      public Tlvs getTlvs()
      Return current value associated with the property corresponding to Stat.getTlvs().
      Returns:
      current value

    • augmentation

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

    • setPeerHeader

      public StatsReportsMessageBuilder setPeerHeader(PeerHeader value)
      Set the property corresponding to PeerHeader.getPeerHeader() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTlvs

      public StatsReportsMessageBuilder setTlvs(Tlvs value)
      Set the property corresponding to Stat.getTlvs() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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