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

Class ArpTpaBuilder

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

       
     ArpTpa createArpTpa(int fooXyzzy, int barBaz) {
         return new ArpTpaBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • ArpTpaBuilder

        public ArpTpaBuilder()
        Construct an empty builder.

      • ArpTpaBuilder

        public ArpTpaBuilder​(ArpTpa base)
        Construct a builder initialized with state from specified ArpTpa.
        Parameters:
        base - ArpTpa from which the builder should be initialized

    • Method Detail

      • getIpv4Address

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getIpv4Address()
        Return current value associated with the property corresponding to ArpTpa.getIpv4Address().
        Returns:
        current value

      • getMask

        public byte[] getMask()
        Return current value associated with the property corresponding to ArpTpa.getMask().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpTpa>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        Parameters:
        augmentationType - augmentation type class
        Returns:
        Augmentation object from this builder, or null if not present
        Throws:
        NullPointerException - if augmentType is null

      • setIpv4Address

        public ArpTpaBuilder setIpv4Address​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
        Set the property corresponding to ArpTpa.getIpv4Address() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setMask

        public ArpTpaBuilder setMask​(byte[] value)
        Set the property corresponding to ArpTpa.getMask() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

        public ArpTpaBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<ArpTpa> 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 ArpTpaBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpTpa>> 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 @NonNull ArpTpa build()
        A new ArpTpa instance.
        Returns:
        A new ArpTpa instance.