Class LearntVpnVipToPortBuilder

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

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

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

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

      • LearntVpnVipToPortBuilder

        public LearntVpnVipToPortBuilder()
      • LearntVpnVipToPortBuilder

        public LearntVpnVipToPortBuilder​(LearntVpnVipToPort base)
    • Method Detail

      • getCreationTime

        public java.lang.String getCreationTime()
      • getMacAddress

        public java.lang.String getMacAddress()
      • getPortFixedip

        public java.lang.String getPortFixedip()
      • getPortName

        public java.lang.String getPortName()
      • getVpnName

        public java.lang.String getVpnName()
      • augmentation

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

        public LearntVpnVipToPortBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<LearntVpnVipToPort> 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 LearntVpnVipToPortBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LearntVpnVipToPort>> 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 LearntVpnVipToPort build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<LearntVpnVipToPort>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<LearntVpnVipToPort,​java.lang.IllegalArgumentException>