Class SrcNxIpv6DstCaseBuilder


  • @Generated("mdsal-binding-generator")
    public class SrcNxIpv6DstCaseBuilder
    extends Object
    Class that builds SrcNxIpv6DstCase 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:

       
         SrcNxIpv6DstCase createSrcNxIpv6DstCase(int fooXyzzy, int barBaz) {
             return new SrcNxIpv6DstCaseBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

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

      • SrcNxIpv6DstCaseBuilder

        public SrcNxIpv6DstCaseBuilder()
        Construct an empty builder.
      • SrcNxIpv6DstCaseBuilder

        public SrcNxIpv6DstCaseBuilder​(NxmNxIpv6DstGrouping arg)
        Construct a new builder initialized from specified NxmNxIpv6DstGrouping.
        Parameters:
        arg - NxmNxIpv6DstGrouping from which the builder should be initialized
      • SrcNxIpv6DstCaseBuilder

        public SrcNxIpv6DstCaseBuilder​(SrcNxIpv6DstCase base)
        Construct a builder initialized with state from specified SrcNxIpv6DstCase.
        Parameters:
        base - SrcNxIpv6DstCase from which the builder should be initialized
    • Method Detail

      • fieldsFrom

        public void fieldsFrom​(org.opendaylight.yangtools.yang.binding.DataObject arg)
        Set fields from given grouping argument. Valid argument is instance of one of following types:
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getNxIpv6Dst

        public org.opendaylight.yangtools.yang.common.Empty getNxIpv6Dst()
        Return current value associated with the property corresponding to NxmNxIpv6DstGrouping.getNxIpv6Dst().
        Returns:
        current value
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrcNxIpv6DstCase>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        Parameters:
        augmentationType - augmentation type class
        Returns:
        Augmentation object from this builder, or null if not present
        Throws:
        NullPointerException - if augmentType is null
      • addAugmentation

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

        public SrcNxIpv6DstCaseBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrcNxIpv6DstCase>> 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