Class Icmpv6NdOptionsTypeBuilder

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

         Icmpv6NdOptionsType createIcmpv6NdOptionsType(int fooXyzzy, int barBaz) {
             return new Icmpv6NdOptionsTypeBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

    This pattern is supported by the immutable nature of Icmpv6NdOptionsType, 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

      • Icmpv6NdOptionsTypeBuilder

        public Icmpv6NdOptionsTypeBuilder()
        Construct an empty builder.
      • Icmpv6NdOptionsTypeBuilder

        public Icmpv6NdOptionsTypeBuilder​(Icmpv6NdOptionsType base)
        Construct a builder initialized with state from specified Icmpv6NdOptionsType.
        base - Icmpv6NdOptionsType from which the builder should be initialized
    • Method Detail

      • getIcmpv6NdOptionsType

        public org.opendaylight.yangtools.yang.common.Uint8 getIcmpv6NdOptionsType()
        Return current value associated with the property corresponding to Icmpv6NdOptionsType.getIcmpv6NdOptionsType().
        current value
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsType>> 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 Icmpv6NdOptionsTypeBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsType> augmentation)
        Add an augmentation to this builder's product.
        augmentation - augmentation to be added
        this builder
        NullPointerException - if augmentation is null
      • removeAugmentation

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