Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.neighbor.state.messages

Class ReceivedBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.neighbor.state.messages.ReceivedBuilder
@Generated("mdsal-binding-generator") public class ReceivedBuilder extends Object
Class that builds Received 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: 

   
     Received createReceived(int fooXyzzy, int barBaz) {
         return new ReceivedBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ReceivedBuilder

      public ReceivedBuilder()
      Construct an empty builder.

    • ReceivedBuilder

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

    • ReceivedBuilder

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

    • ReceivedBuilder

      public ReceivedBuilder(Received base)
      Construct a builder initialized with state from specified Received.
      Parameters:
      base - Received 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 Received empty()
      Get empty instance of Received.
      Returns:
      An empty Received

    • getNOTIFICATION

      public org.opendaylight.yangtools.yang.common.Uint64 getNOTIFICATION()
      Return current value associated with the property corresponding to BgpCountersMessageTypesCommon.getNOTIFICATION().
      Returns:
      current value

    • getUPDATE

      public org.opendaylight.yangtools.yang.common.Uint64 getUPDATE()
      Return current value associated with the property corresponding to BgpCountersMessageTypesCommon.getUPDATE().
      Returns:
      current value

    • augmentation

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

    • setNOTIFICATION

      public ReceivedBuilder setNOTIFICATION(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to BgpCountersMessageTypesCommon.getNOTIFICATION() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setUPDATE

      public ReceivedBuilder setUPDATE(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to BgpCountersMessageTypesCommon.getUPDATE() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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