Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.monitoring.response.monitoring.metrics.list

Class GeneralMetricsListBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.monitoring.response.monitoring.metrics.list.GeneralMetricsListBuilder
@Generated("mdsal-binding-generator") public class GeneralMetricsListBuilder extends Object
Class that builds GeneralMetricsList 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: 

   
     GeneralMetricsList createGeneralMetricsList(int fooXyzzy, int barBaz) {
         return new GeneralMetricsListBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • GeneralMetricsListBuilder

      public GeneralMetricsListBuilder()
      Construct an empty builder.

    • GeneralMetricsListBuilder

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

    • GeneralMetricsListBuilder

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

    • getMetricPce

      public List<MetricPce> getMetricPce()
      Return current value associated with the property corresponding to MonitoringMetrics.getMetricPce().
      Returns:
      current value

    • augmentation

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

    • setMetricPce

      public GeneralMetricsListBuilder setMetricPce(List<MetricPce> values)
      Set the property corresponding to MonitoringMetrics.getMetricPce() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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