Class ReadFlowTestInputBuilder

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

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

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

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

      • ReadFlowTestInputBuilder

        public ReadFlowTestInputBuilder()
      • ReadFlowTestInputBuilder

        public ReadFlowTestInputBuilder​(ReadFlowTestInput base)
    • Method Detail

      • getDpnCount

        public org.opendaylight.yangtools.yang.common.Uint32 getDpnCount()
      • getEndTableId

        public org.opendaylight.yangtools.yang.common.Uint32 getEndTableId()
      • getFlowsPerDpn

        public org.opendaylight.yangtools.yang.common.Uint32 getFlowsPerDpn()
      • getIsConfigDs

        public Boolean getIsConfigDs()
      • isIsConfigDs

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

        public org.opendaylight.yangtools.yang.common.Uint32 getStartTableId()
      • getVerbose

        public Boolean getVerbose()
      • isVerbose

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

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

        public ReadFlowTestInputBuilder setEndTableId​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setFlowsPerDpn

        public ReadFlowTestInputBuilder setFlowsPerDpn​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setStartTableId

        public ReadFlowTestInputBuilder setStartTableId​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • addAugmentation

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