Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.metric.object

Class MetricBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.metric.object.MetricBuilder
@Generated("mdsal-binding-generator") public class MetricBuilder extends Object
Class that builds Metric 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: 

   
     Metric createMetric(int fooXyzzy, int barBaz) {
         return new MetricBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MetricBuilder

      public MetricBuilder()
      Construct an empty builder.

    • MetricBuilder

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

    • MetricBuilder

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

    • MetricBuilder

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

    • getBound

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

    • getComputed

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

    • getIgnore

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

    • getMetricType

      public org.opendaylight.yangtools.yang.common.Uint8 getMetricType()
      Return current value associated with the property corresponding to Metric.getMetricType().
      Returns:
      current value

    • getProcessingRule

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

    • getValue

      public Float32 getValue()
      Return current value associated with the property corresponding to Metric.getValue().
      Returns:
      current value

    • augmentation

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

    • setBound

      public MetricBuilder setBound(Boolean value)
      Set the property corresponding to Metric.getBound() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setComputed

      public MetricBuilder setComputed(Boolean value)
      Set the property corresponding to Metric.getComputed() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIgnore

      public MetricBuilder setIgnore(Boolean value)
      Set the property corresponding to ObjectHeader.getIgnore() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMetricType

      public MetricBuilder setMetricType(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to Metric.getMetricType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setProcessingRule

      public MetricBuilder setProcessingRule(Boolean value)
      Set the property corresponding to ObjectHeader.getProcessingRule() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setValue

      public MetricBuilder setValue(Float32 value)
      Set the property corresponding to Metric.getValue() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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