Class RouterPortsBuilder

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

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

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

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

      • RouterPortsBuilder

        public RouterPortsBuilder()
      • RouterPortsBuilder

        public RouterPortsBuilder​(RouterPorts base)
    • Method Detail

      • getExternalNetworkId

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

        public java.util.List<Ports> getPorts()
      • getRouterId

        public java.lang.String getRouterId()
      • augmentation

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

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

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

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

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