Class Icmpv6NdReservedValuesBuilder


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

       
         Icmpv6NdReservedValues createIcmpv6NdReservedValues(int fooXyzzy, int barBaz) {
             return new Icmpv6NdReservedValuesBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

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

      • Icmpv6NdReservedValuesBuilder

        public Icmpv6NdReservedValuesBuilder()
        Construct an empty builder.
      • Icmpv6NdReservedValuesBuilder

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

      • getIcmpv6NdReserved

        public org.opendaylight.yangtools.yang.common.Uint32 getIcmpv6NdReserved()
        Return current value associated with the property corresponding to Icmpv6NdReservedValues.getIcmpv6NdReserved().
        Returns:
        current value
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdReservedValues>> 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
      • removeAugmentation

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