Class MetricObjectBuilder

  • @Generated("mdsal-binding-generator")
    public class MetricObjectBuilder
    extends Object
    Class that builds MetricObject 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:

         MetricObject createMetricObject(int fooXyzzy, int barBaz) {
             return new MetricObjectBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • MetricObjectBuilder

        public MetricObjectBuilder()
        Construct an empty builder.
      • MetricObjectBuilder

        public MetricObjectBuilder​(RsvpTeObject arg)
        Construct a new builder initialized from specified RsvpTeObject.
        arg - RsvpTeObject from which the builder should be initialized
      • MetricObjectBuilder

        public MetricObjectBuilder​(MetricObject base)
        Construct a builder initialized with state from specified MetricObject.
        base - MetricObject from which the builder should be initialized
    • Method Detail

      • 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:
        arg - grouping object
        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 MetricObject.getBound().
        current value
      • getMetricType

        public org.opendaylight.yangtools.yang.common.Uint8 getMetricType()
        Return current value associated with the property corresponding to MetricObject.getMetricType().
        current value
      • getValue

        public Float32 getValue()
        Return current value associated with the property corresponding to MetricObject.getValue().
        current value
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MetricObject>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        augmentationType - augmentation type class
        Augmentation object from this builder, or null if not present
        NullPointerException - if augmentType is null
      • setMetricType

        public MetricObjectBuilder setMetricType​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to MetricObject.getMetricType() to the specified value.
        value - desired value
        this builder
      • addAugmentation

        public MetricObjectBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<MetricObject> augmentation)
        Add an augmentation to this builder's product.
        augmentation - augmentation to be added
        this builder
        NullPointerException - if augmentation is null
      • removeAugmentation

        public MetricObjectBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MetricObject>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        augmentationType - augmentation type to be removed
        this builder