Class ListenerCongfigBuilder

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

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

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

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

      • ListenerCongfigBuilder

        public ListenerCongfigBuilder()
      • ListenerCongfigBuilder

        public ListenerCongfigBuilder​(ListenerCongfig base)
    • Method Detail

      • getLimit

        public org.opendaylight.yangtools.yang.common.Uint16 getLimit()
      • getPeerGroup

        public java.lang.String getPeerGroup()
      • getRange

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

        public java.lang.Boolean isEnable()
      • augmentation

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

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

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

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

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

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