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

Class SpecificMetricsBuilder

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

   
     SpecificMetrics createSpecificMetrics(int fooXyzzy, int barBaz) {
         return new SpecificMetricsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SpecificMetricsBuilder

      public SpecificMetricsBuilder()
      Construct an empty builder.

    • SpecificMetricsBuilder

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

    • SpecificMetricsBuilder

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

    • SpecificMetricsBuilder

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

    • getRp

      public Rp getRp()
      Return current value associated with the property corresponding to RpObject.getRp().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetrics>> 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 SpecificMetricsBuilder setMetricPce(List<MetricPce> values)
      Set the property corresponding to MonitoringMetrics.getMetricPce() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setRp

      public SpecificMetricsBuilder setRp(Rp value)
      Set the property corresponding to RpObject.getRp() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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