Class VplsBuilder

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

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

         VplsBuilder createTarget(int fooXyzzy, int barBaz) {
             return new VplsBuilderBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      VplsBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpls>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Vpls> augmentationValue)  
      <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpls>>
      augmentation​(java.lang.Class<E$$> augmentationType)  
      Vpls build()  
      Bgp getBgp()  
      VplsBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vpls>> augmentationType)  
      VplsBuilder setBgp​(Bgp value)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • VplsBuilder

        public VplsBuilder()
      • VplsBuilder

        public VplsBuilder​(Vpls base)
    • Method Detail

      • getBgp

        public Bgp getBgp()
      • augmentation

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

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

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

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