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

Class MonitorBuilder

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

   
     Monitor createMonitor(int fooXyzzy, int barBaz) {
         return new MonitorBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MonitorBuilder

      public MonitorBuilder()
      Construct an empty builder.

    • MonitorBuilder

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

    • MonitorBuilder

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

    • key

      public MonitorKey key()
      Return current value associated with the property corresponding to Monitor.key().
      Returns:
      current value

    • getMonitorId

      public MonitorId getMonitorId()
      Return current value associated with the property corresponding to Monitor.getMonitorId().
      Returns:
      current value

    • getRouter

      public Map<RouterKey,Router> getRouter()
      Return current value associated with the property corresponding to Routers.getRouter().
      Returns:
      current value

    • augmentation

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

    • withKey

      public MonitorBuilder withKey(MonitorKey key)
      Set the key value corresponding to Monitor.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setMonitorId

      public MonitorBuilder setMonitorId(MonitorId value)
      Set the property corresponding to Monitor.getMonitorId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRouter

      public MonitorBuilder setRouter(Map<RouterKey,Router> values)
      Set the property corresponding to Routers.getRouter() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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