Class DenyBuilder

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

    @Generated("mdsal-binding-generator")
    public class DenyBuilder
    extends java.lang.Object
    implements org.opendaylight.yangtools.concepts.Builder<Deny>
    Class that builds DenyBuilder 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:

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

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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      DenyBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Deny> augmentation)
      Add an augmentation to this builder's product.
      <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Deny>>
      E$$
      augmentation​(java.lang.Class<E$$> augmentationType)  
      Deny build()  
      org.opendaylight.yangtools.yang.common.Empty getDeny()  
      DenyBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Deny>> augmentationType)
      Remove an augmentation from this builder's product.
      DenyBuilder setDeny​(org.opendaylight.yangtools.yang.common.Empty value)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DenyBuilder

        public DenyBuilder()
      • DenyBuilder

        public DenyBuilder​(Deny base)
    • Method Detail

      • getDeny

        public org.opendaylight.yangtools.yang.common.Empty getDeny()
      • augmentation

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

        public DenyBuilder setDeny​(org.opendaylight.yangtools.yang.common.Empty value)
      • addAugmentation

        public DenyBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Deny> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        java.lang.NullPointerException - if augmentation is null
      • removeAugmentation

        public DenyBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Deny>> 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
      • build

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