Class QosalertConfigBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<QosalertConfig>, org.opendaylight.yangtools.concepts.CheckedBuilder<QosalertConfig,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    public class QosalertConfigBuilder
    extends java.lang.Object
    implements org.opendaylight.yangtools.concepts.Builder<QosalertConfig>
    Class that builds QosalertConfigBuilder 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:

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

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

      • QosalertConfigBuilder

        public QosalertConfigBuilder()
      • QosalertConfigBuilder

        public QosalertConfigBuilder​(QosalertConfig base)
    • Method Detail

      • getQosAlertPollInterval

        public org.opendaylight.yangtools.yang.common.Uint16 getQosAlertPollInterval()
      • getQosDropPacketThreshold

        public org.opendaylight.yangtools.yang.common.Uint8 getQosDropPacketThreshold()
      • isQosAlertEnabled

        public java.lang.Boolean isQosAlertEnabled()
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<QosalertConfig>> E$$ augmentation​(java.lang.Class<E$$> augmentationType)
      • setQosAlertPollInterval

        public QosalertConfigBuilder setQosAlertPollInterval​(org.opendaylight.yangtools.yang.common.Uint16 value)
      • setQosAlertPollInterval

        @Deprecated(forRemoval=true)
        public QosalertConfigBuilder setQosAlertPollInterval​(java.lang.Integer value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setQosAlertPollInterval(Uint16)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • setQosDropPacketThreshold

        public QosalertConfigBuilder setQosDropPacketThreshold​(org.opendaylight.yangtools.yang.common.Uint8 value)
      • setQosDropPacketThreshold

        @Deprecated(forRemoval=true)
        public QosalertConfigBuilder setQosDropPacketThreshold​(java.lang.Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setQosDropPacketThreshold(Uint8)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • addAugmentation

        public QosalertConfigBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<QosalertConfig>> augmentationType,
                                                     org.opendaylight.yangtools.yang.binding.Augmentation<QosalertConfig> augmentationValue)
      • removeAugmentation

        public QosalertConfigBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<QosalertConfig>> augmentationType)
      • build

        public QosalertConfig build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<QosalertConfig>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<QosalertConfig,​java.lang.IllegalArgumentException>