Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.dhcp_allocation_pool.rev161214.dhcp_allocation_pool.network

Class AllocationPoolBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<AllocationPool>, org.opendaylight.yangtools.concepts.CheckedBuilder<AllocationPool,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class AllocationPoolBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<AllocationPool>
    Class that builds AllocationPoolBuilder 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: 

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

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

    • Constructor Detail

      • AllocationPoolBuilder

        public AllocationPoolBuilder()

      • AllocationPoolBuilder

        public AllocationPoolBuilder​(AllocationPool base)

    • Method Detail

      • getAllocateFrom

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

      • getAllocateTo

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

      • getDnsServers

        public java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> getDnsServers()

      • getGateway

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

      • getSubnet

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

      • augmentation

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

      • setAllocateFrom

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

      • setAllocateTo

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

      • setDnsServers

        public AllocationPoolBuilder setDnsServers​(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> values)

      • setGateway

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

      • setSubnet

        public AllocationPoolBuilder setSubnet​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)

      • addAugmentation

        public AllocationPoolBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AllocationPool>> augmentationType,
                                             org.opendaylight.yangtools.yang.binding.Augmentation<AllocationPool> augmentationValue)

      • removeAugmentation

        public AllocationPoolBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AllocationPool>> augmentationType)

      • build

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