Class RemoteDpnsBuilder

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

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

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

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

      • RemoteDpnsBuilder

        public RemoteDpnsBuilder()
      • RemoteDpnsBuilder

        public RemoteDpnsBuilder​(RemoteDpns base)
    • Method Detail

      • getDestinationDpnId

        public org.opendaylight.yangtools.yang.common.Uint64 getDestinationDpnId()
      • getMonitoringInterval

        public org.opendaylight.yangtools.yang.common.Uint16 getMonitoringInterval()
      • getTunnelName

        public java.lang.String getTunnelName()
      • isInternal

        public java.lang.Boolean isInternal()
      • isMonitoringEnabled

        public java.lang.Boolean isMonitoringEnabled()
      • augmentation

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

        public RemoteDpnsBuilder setDestinationDpnId​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setDestinationDpnId

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

        public RemoteDpnsBuilder setMonitoringInterval​(org.opendaylight.yangtools.yang.common.Uint16 value)
      • setMonitoringInterval

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

        public RemoteDpnsBuilder setMonitoringEnabled​(java.lang.Boolean value)
      • addAugmentation

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

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

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