Class IsisBuilder

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

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

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

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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      IsisBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Isis>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Isis> augmentationValue)  
      <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Isis>>
      E$$
      augmentation​(java.lang.Class<E$$> augmentationType)  
      Isis build()  
      java.lang.Boolean isEnableIsis()  
      IsisBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Isis>> augmentationType)  
      IsisBuilder setEnableIsis​(java.lang.Boolean value)  
      • Methods inherited from class java.lang.Object

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

      • IsisBuilder

        public IsisBuilder()
      • IsisBuilder

        public IsisBuilder​(Isis base)
    • Method Detail

      • isEnableIsis

        public java.lang.Boolean isEnableIsis()
      • augmentation

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

        public IsisBuilder setEnableIsis​(java.lang.Boolean value)
      • addAugmentation

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

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

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