Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.arputil.rev160406

Class ArpRequestReceivedBuilder

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

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

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

    • Constructor Detail

      • ArpRequestReceivedBuilder

        public ArpRequestReceivedBuilder()

      • ArpRequestReceivedBuilder

        public ArpRequestReceivedBuilder​(ArpRequestReceived base)

    • Method Detail

      • getDpnId

        public org.opendaylight.yangtools.yang.common.Uint64 getDpnId()

      • getDstIpaddress

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

      • getInterface

        public java.lang.String getInterface()

      • getMetadata

        public org.opendaylight.yangtools.yang.common.Uint64 getMetadata()

      • getOfTableId

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

      • getSrcIpaddress

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

      • getSrcMac

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress getSrcMac()

      • augmentation

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

      • setDpnId

        @Deprecated(forRemoval=true)
public ArpRequestReceivedBuilder setDpnId​(java.math.BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setDpnId(Uint64) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setDstIpaddress

        public ArpRequestReceivedBuilder setDstIpaddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)

      • setMetadata

        @Deprecated(forRemoval=true)
public ArpRequestReceivedBuilder setMetadata​(java.math.BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setMetadata(Uint64) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setOfTableId

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

      • setSrcIpaddress

        public ArpRequestReceivedBuilder setSrcIpaddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)

      • setSrcMac

        public ArpRequestReceivedBuilder setSrcMac​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress value)

      • addAugmentation

        public ArpRequestReceivedBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<ArpRequestReceived> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        java.lang.NullPointerException - if augmentation is null

      • removeAugmentation

        public ArpRequestReceivedBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpRequestReceived>> 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

      • build

        public ArpRequestReceived build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<ArpRequestReceived>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<ArpRequestReceived,​java.lang.IllegalArgumentException>