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

Class MonitoringBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Monitoring>, org.opendaylight.yangtools.concepts.CheckedBuilder<Monitoring,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class MonitoringBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Monitoring>
    Class that builds Monitoring 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: 

       
     Monitoring createMonitoring(int fooXyzzy, int barBaz) {
         return new MonitoringBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • MonitoringBuilder

        public MonitoringBuilder()

      • MonitoringBuilder

        public MonitoringBuilder​(Object arg)

      • MonitoringBuilder

        public MonitoringBuilder​(ObjectHeader arg)

      • MonitoringBuilder

        public MonitoringBuilder​(Monitoring 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:
        • ObjectHeader
        • Object
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getIgnore

        public Boolean getIgnore()

      • getMonitoringId

        public org.opendaylight.yangtools.yang.common.Uint32 getMonitoringId()

      • getProcessingRule

        public Boolean getProcessingRule()

      • getTlvs

        public Tlvs getTlvs()

      • augmentation

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

      • setMonitoringId

        public MonitoringBuilder setMonitoringId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • addAugmentation

        public MonitoringBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Monitoring> 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 MonitoringBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Monitoring>> 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