Class DPNTEPsInfoBuilder

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

    @Generated("mdsal-binding-generator")
    public class DPNTEPsInfoBuilder
    extends java.lang.Object
    implements org.opendaylight.yangtools.concepts.Builder<DPNTEPsInfo>
    Class that builds DPNTEPsInfoBuilder 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:

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

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

      • DPNTEPsInfoBuilder

        public DPNTEPsInfoBuilder()
      • DPNTEPsInfoBuilder

        public DPNTEPsInfoBuilder​(DPNTEPsInfo base)
    • Method Detail

      • getDPNID

        public org.opendaylight.yangtools.yang.common.Uint64 getDPNID()
      • getDstId

        public java.lang.Integer getDstId()
      • getTunnelEndPoints

        public java.util.List<TunnelEndPoints> getTunnelEndPoints()
      • getUp

        public java.lang.Boolean getUp()
      • isUp

        @Deprecated(forRemoval=true)
        public final java.lang.Boolean isUp()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • augmentation

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

        public DPNTEPsInfoBuilder setDPNID​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setDPNID

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

        public DPNTEPsInfoBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<DPNTEPsInfo> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        java.lang.NullPointerException - if augmentation is null
      • removeAugmentation

        public DPNTEPsInfoBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DPNTEPsInfo>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        Parameters:
        augmentationType - augmentation type to be removed
        Returns:
        this builder
      • build

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