Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.of.udp.dst.grouping

Class NxmOfUdpDstBuilder

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

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

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

    • Constructor Detail

      • NxmOfUdpDstBuilder

        public NxmOfUdpDstBuilder()

      • NxmOfUdpDstBuilder

        public NxmOfUdpDstBuilder​(NxmOfUdpDst base)

    • Method Detail

      • getMask

        public org.opendaylight.yangtools.yang.common.Uint16 getMask()

      • getPort

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPort()

      • augmentation

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

      • setMask

        public NxmOfUdpDstBuilder setMask​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setPort

        public NxmOfUdpDstBuilder setPort​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)

      • addAugmentation

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