Class RoutersBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Routers>, org.opendaylight.yangtools.concepts.CheckedBuilder<Routers,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    public class RoutersBuilder
    extends java.lang.Object
    implements org.opendaylight.yangtools.concepts.Builder<Routers>
    Class that builds RoutersBuilder 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:

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

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

      • RoutersBuilder

        public RoutersBuilder()
      • RoutersBuilder

        public RoutersBuilder​(Routers base)
    • Method Detail

      • getExtGwMacAddress

        public java.lang.String getExtGwMacAddress()
      • getExternalIps

        public java.util.List<ExternalIps> getExternalIps()
      • getNetworkId

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

        public java.lang.String getRouterName()
      • getSubnetIds

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

        public java.lang.Boolean isEnableSnat()
      • augmentation

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

        public RoutersBuilder setExtGwMacAddress​(java.lang.String value)
      • setNetworkId

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

        public RoutersBuilder setRouterName​(java.lang.String value)
      • setSubnetIds

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

        public RoutersBuilder setEnableSnat​(java.lang.Boolean value)
      • addAugmentation

        public RoutersBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routers>> augmentationType,
                                              org.opendaylight.yangtools.yang.binding.Augmentation<Routers> augmentationValue)
      • removeAugmentation

        public RoutersBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routers>> augmentationType)
      • build

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