Class DpnInterfacesBuilder

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

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

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

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

      • DpnInterfacesBuilder

        public DpnInterfacesBuilder()
      • DpnInterfacesBuilder

        public DpnInterfacesBuilder​(DpnInterfaces base)
    • Method Detail

      • getDpId

        public org.opendaylight.yangtools.yang.common.Uint64 getDpId()
      • getInterfaces

        public java.util.List<java.lang.String> getInterfaces()
      • augmentation

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

        public DpnInterfacesBuilder setDpId​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setDpId

        @Deprecated(forRemoval=true)
        public DpnInterfacesBuilder setDpId​(java.math.BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setDpId(Uint64)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • setInterfaces

        public DpnInterfacesBuilder setInterfaces​(java.util.List<java.lang.String> values)
      • addAugmentation

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

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

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