Class RemoveEventDataBuilder

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

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

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

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

      • RemoveEventDataBuilder

        public RemoveEventDataBuilder()
      • RemoveEventDataBuilder

        public RemoveEventDataBuilder​(DpnInVpnEvent arg)
      • RemoveEventDataBuilder

        public RemoveEventDataBuilder​(RemoveEventData base)
    • Method Detail

      • fieldsFrom

        public void fieldsFrom​(org.opendaylight.yangtools.yang.binding.DataObject arg)
        Set fields from given grouping argument. Valid argument is instance of one of following types:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.DpnInVpnEvent
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types
      • getDpnId

        public org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
      • getRd

        public java.lang.String getRd()
      • getVpnName

        public java.lang.String getVpnName()
      • augmentation

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

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

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

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

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