Class NxmNxNshTtlBuilder

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

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

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

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

      • NxmNxNshTtlBuilder

        public NxmNxNshTtlBuilder()
      • NxmNxNshTtlBuilder

        public NxmNxNshTtlBuilder​(NxmNxNshTtl base)
    • Method Detail

      • getNshTtl

        public org.opendaylight.yangtools.yang.common.Uint8 getNshTtl()
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshTtl>> E$$ augmentation​(Class<E$$> augmentationType)
      • setNshTtl

        public NxmNxNshTtlBuilder setNshTtl​(org.opendaylight.yangtools.yang.common.Uint8 value)
      • setNshTtl

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

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

        public NxmNxNshTtlBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshTtl>> 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