Class AddressFamiliesVrfBuilder

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

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

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

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

      • AddressFamiliesVrfBuilder

        public AddressFamiliesVrfBuilder()
      • AddressFamiliesVrfBuilder

        public AddressFamiliesVrfBuilder​(AddressFamiliesVrf base)
    • Method Detail

      • getAfi

        public org.opendaylight.yangtools.yang.common.Uint32 getAfi()
      • getSafi

        public org.opendaylight.yangtools.yang.common.Uint32 getSafi()
      • augmentation

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

        @Deprecated(forRemoval=true)
        public AddressFamiliesVrfBuilder setAfi​(java.lang.Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setAfi(Uint32)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • setSafi

        @Deprecated(forRemoval=true)
        public AddressFamiliesVrfBuilder setSafi​(java.lang.Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setSafi(Uint32)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • build

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