Package org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.address

Class Ipv4Builder

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

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

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

    • Constructor Detail

      • Ipv4Builder

        public Ipv4Builder()

      • Ipv4Builder

        public Ipv4Builder​(Ipv4 base)

    • Method Detail

      • getIpv4Address

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

      • augmentation

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

      • setIpv4Address

        public Ipv4Builder setIpv4Address​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value)

      • addAugmentation

        public Ipv4Builder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4> 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 Ipv4Builder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> 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 Ipv4 build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Ipv4>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4,​IllegalArgumentException>