Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes

Class FixedIpsBuilder

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

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

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

    • Constructor Detail

      • FixedIpsBuilder

        public FixedIpsBuilder()

      • FixedIpsBuilder

        public FixedIpsBuilder​(FixedIps base)

    • Method Detail

      • getIpAddress

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

      • getSubnetId

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

      • augmentation

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

      • setIpAddress

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

      • setSubnetId

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

      • addAugmentation

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