Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets

Class SubnetsBuilder

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

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

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      SubnetsBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Subnets> augmentation)
      Add an augmentation to this builder's product.
      <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Subnets>>
      E$$      		 augmentation​(java.lang.Class<E$$> augmentationType)  
      Subnets build()  
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getExternalNetworkId()  
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getId()  
      java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getRouterIds()  
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getVpnId()  
      SubnetsKey key()  
      SubnetsBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Subnets>> augmentationType)
      Remove an augmentation from this builder's product.
      SubnetsBuilder setExternalNetworkId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)  
      SubnetsBuilder setId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)  
      SubnetsBuilder setRouterIds​(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)  
      SubnetsBuilder setVpnId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)  
      SubnetsBuilder withKey​(SubnetsKey key)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SubnetsBuilder

        public SubnetsBuilder()

      • SubnetsBuilder

        public SubnetsBuilder​(Subnets base)

    • Method Detail

      • getExternalNetworkId

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

      • getId

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

      • getRouterIds

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

      • getVpnId

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

      • augmentation

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

      • setExternalNetworkId

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

      • setId

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

      • setRouterIds

        public SubnetsBuilder setRouterIds​(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)

      • setVpnId

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

      • addAugmentation

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

      • removeAugmentation

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