Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.nxm.of.match.ip.dst.grouping

Class IpDstValuesBuilder

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

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

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

    • Constructor Detail

      • IpDstValuesBuilder

        public IpDstValuesBuilder()

      • IpDstValuesBuilder

        public IpDstValuesBuilder​(IpDstValues base)

    • Method Detail

      • getValue

        public org.opendaylight.yangtools.yang.common.Uint32 getValue()

      • augmentation

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

      • setValue

        public IpDstValuesBuilder setValue​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setValue

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

      • addAugmentation

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