Class SrcNxTunIpv4DstCaseBuilder

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

         SrcNxTunIpv4DstCase createSrcNxTunIpv4DstCase(int fooXyzzy, int barBaz) {
             return new SrcNxTunIpv4DstCaseBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • SrcNxTunIpv4DstCaseBuilder

        public SrcNxTunIpv4DstCaseBuilder()
        Construct an empty builder.
      • SrcNxTunIpv4DstCaseBuilder

        public SrcNxTunIpv4DstCaseBuilder​(NxmNxTunIpv4DstGrouping arg)
        Construct a new builder initialized from specified NxmNxTunIpv4DstGrouping.
        arg - NxmNxTunIpv4DstGrouping from which the builder should be initialized
      • SrcNxTunIpv4DstCaseBuilder

        public SrcNxTunIpv4DstCaseBuilder​(SrcNxTunIpv4DstCase base)
        Construct a builder initialized with state from specified SrcNxTunIpv4DstCase.
        base - SrcNxTunIpv4DstCase 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:
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getNxTunIpv4Dst

        public org.opendaylight.yangtools.yang.common.Empty getNxTunIpv4Dst()
        Return current value associated with the property corresponding to NxmNxTunIpv4DstGrouping.getNxTunIpv4Dst().
        current value
      • augmentation

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

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

        public SrcNxTunIpv4DstCaseBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrcNxTunIpv4DstCase>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        augmentationType - augmentation type to be removed
        this builder