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

Class PeerDownNotificationBuilder

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

   
     PeerDownNotification createPeerDownNotification(int fooXyzzy, int barBaz) {
         return new PeerDownNotificationBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PeerDownNotificationBuilder

      public PeerDownNotificationBuilder()
      Construct an empty builder.

    • PeerDownNotificationBuilder

      public PeerDownNotificationBuilder(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

    • PeerDownNotificationBuilder

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

    • PeerDownNotificationBuilder

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

    • getData

      public Data getData()
      Return current value associated with the property corresponding to PeerDown.getData().
      Returns:
      current value

    • getLocalSystemClosed

      public Boolean getLocalSystemClosed()
      Return current value associated with the property corresponding to PeerDown.getLocalSystemClosed().
      Returns:
      current value

    • getPeerHeader

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

    • augmentation

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

    • setData

      public PeerDownNotificationBuilder setData(Data value)
      Set the property corresponding to PeerDown.getData() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLocalSystemClosed

      public PeerDownNotificationBuilder setLocalSystemClosed(Boolean value)
      Set the property corresponding to PeerDown.getLocalSystemClosed() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPeerHeader

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

    • addAugmentation

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