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

Class MetricPceBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<MetricPce>, org.opendaylight.yangtools.concepts.CheckedBuilder<MetricPce,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class MetricPceBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<MetricPce>
    Class that builds MetricPceBuilder 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: 

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

    This pattern is supported by the immutable nature of MetricPceBuilder, 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 oportunities, 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:
    MetricPceBuilder, Builder

    • Constructor Detail

      • MetricPceBuilder

        public MetricPceBuilder()

      • MetricPceBuilder

        public MetricPceBuilder​(PceIdObject arg)

      • MetricPceBuilder

        public MetricPceBuilder​(MetricPce base)

    • 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:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.OverloadObject
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.PceIdObject
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ProcTimeObject
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getOverload

        public Overload getOverload()

      • getPceId

        public PceId getPceId()

      • getProcTime

        public ProcTime getProcTime()

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MetricPce>> E$$ augmentation​(Class<E$$> augmentationType)

      • addAugmentation

        public MetricPceBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MetricPce>> augmentationType,
                                        org.opendaylight.yangtools.yang.binding.Augmentation<MetricPce> augmentationValue)

      • removeAugmentation

        public MetricPceBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MetricPce>> augmentationType)