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

Class MetricPceBuilder

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

   
     MetricPce createMetricPce(int fooXyzzy, int barBaz) {
         return new MetricPceBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MetricPceBuilder

      public MetricPceBuilder()
      Construct an empty builder.

    • MetricPceBuilder

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

    • MetricPceBuilder

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

    • MetricPceBuilder

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

    • MetricPceBuilder

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

    • getOverload

      public Overload getOverload()
      Return current value associated with the property corresponding to OverloadObject.getOverload().
      Returns:
      current value

    • getPceId

      public PceId getPceId()
      Return current value associated with the property corresponding to PceIdObject.getPceId().
      Returns:
      current value

    • getProcTime

      public ProcTime getProcTime()
      Return current value associated with the property corresponding to ProcTimeObject.getProcTime().
      Returns:
      current value

    • augmentation

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

    • setOverload

      public MetricPceBuilder setOverload(Overload value)
      Set the property corresponding to OverloadObject.getOverload() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPceId

      public MetricPceBuilder setPceId(PceId value)
      Set the property corresponding to PceIdObject.getPceId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setProcTime

      public MetricPceBuilder setProcTime(ProcTime value)
      Set the property corresponding to ProcTimeObject.getProcTime() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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