Class NshcCaseValueBuilder

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

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

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

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

      • NshcCaseValueBuilder

        public NshcCaseValueBuilder()
      • NshcCaseValueBuilder

        public NshcCaseValueBuilder​(NshcCaseValue 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.openflowjava.nx.match.rev140421.OfjNxmNxMatchNshcGrouping
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getMask

        public org.opendaylight.yangtools.yang.common.Uint32 getMask()
      • getNshc

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

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

        public NshcCaseValueBuilder setMask​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setMask

        @Deprecated(forRemoval=true)
        public NshcCaseValueBuilder setMask​(Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setMask(Uint32) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • setNshc

        public NshcCaseValueBuilder setNshc​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setNshc

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

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