Class DetectionBuilder

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

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

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

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

      • DetectionBuilder

        public DetectionBuilder()
      • DetectionBuilder

        public DetectionBuilder​(Detection base)
    • Method Detail

      • getThreshold

        public org.opendaylight.yangtools.yang.common.Uint16 getThreshold()
      • isEnable

        public java.lang.Boolean isEnable()
      • augmentation

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

        public DetectionBuilder setThreshold​(org.opendaylight.yangtools.yang.common.Uint16 value)
      • setThreshold

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

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

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

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