Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.icmpv6.code._case

Class Icmpv6CodeBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Icmpv6Code>, org.opendaylight.yangtools.concepts.CheckedBuilder<Icmpv6Code,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class Icmpv6CodeBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Icmpv6Code>
    Class that builds Icmpv6CodeBuilder 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: 

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

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

    • Constructor Detail

      • Icmpv6CodeBuilder

        public Icmpv6CodeBuilder()

      • Icmpv6CodeBuilder

        public Icmpv6CodeBuilder​(Icmpv6Code base)

    • Method Detail

      • getIcmpv6Code

        public org.opendaylight.yangtools.yang.common.Uint8 getIcmpv6Code()

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6Code>> E$$ augmentation​(Class<E$$> augmentationType)

      • setIcmpv6Code

        public Icmpv6CodeBuilder setIcmpv6Code​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setIcmpv6Code

        @Deprecated(forRemoval=true)
public Icmpv6CodeBuilder setIcmpv6Code​(Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setIcmpv6Code(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • addAugmentation

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