Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets

Class SubnetBuilder

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

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

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

    • Constructor Detail

      • SubnetBuilder

        public SubnetBuilder()

      • SubnetBuilder

        public SubnetBuilder​(Subnet base)

    • Method Detail

      • fieldsFrom

        public void fieldsFrom​(org.opendaylight.yangtools.yang.binding.DataObject arg)
        Set fields from given grouping argument. Valid argument is instance of one of following types:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.SubnetAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.IdAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.BaseAttributes
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getCidr

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

      • getDnsNameservers

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

      • getGatewayIp

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

      • getIpv6AddressMode

        public Class<? extends Dhcpv6Base> getIpv6AddressMode()

      • getName

        public String getName()

      • getNetworkId

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

      • getProjectId

        public String getProjectId()

      • getRevisionNumber

        public Long getRevisionNumber()

      • getTenantId

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

      • getUuid

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

      • isEnableDhcp

        public Boolean isEnableDhcp()

      • augmentation

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

      • setAllocationPools

        @Deprecated(forRemoval=true)
public SubnetBuilder setAllocationPools​(List<AllocationPools> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setAllocationPools(Map) instead.
        Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.
        Parameters:
        values - Legacy List of values
        Returns:
        this builder
        Throws:
        IllegalArgumentException - if the list contains entries with the same key
        NullPointerException - if the list contains a null entry

      • setCidr

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

      • setDnsNameservers

        public SubnetBuilder setDnsNameservers​(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> values)

      • setGatewayIp

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

      • setHostRoutes

        @Deprecated(forRemoval=true)
public SubnetBuilder setHostRoutes​(List<HostRoutes> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setHostRoutes(Map) instead.
        Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.
        Parameters:
        values - Legacy List of values
        Returns:
        this builder
        Throws:
        IllegalArgumentException - if the list contains entries with the same key
        NullPointerException - if the list contains a null entry

      • setNetworkId

        public SubnetBuilder setNetworkId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setTenantId

        public SubnetBuilder setTenantId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setUuid

        public SubnetBuilder setUuid​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • addAugmentation

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

      • addAugmentation

        @Deprecated(forRemoval=true)
public SubnetBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Subnet>> augmentationType,
                                     org.opendaylight.yangtools.yang.binding.Augmentation<Subnet> augmentationValue)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use either addAugmentation(Augmentation) or removeAugmentation(Class) instead.
        Add or remove an augmentation to this builder's product.
        Parameters:
        augmentationType - augmentation type to be added or removed
        augmentationValue - augmentation value, null if the augmentation type should be removed
        Returns:
        this builder

      • removeAugmentation

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