Class FlowTestInputBuilder

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

    public class FlowTestInputBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<FlowTestInput>
    Class that builds FlowTestInputBuilder 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:

         FlowTestInputBuilder createTarget(int fooXyzzy, int barBaz) {
             return new FlowTestInputBuilderBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • FlowTestInputBuilder

        public FlowTestInputBuilder()
      • FlowTestInputBuilder

        public FlowTestInputBuilder​(FlowTestInput base)
    • Method Detail

      • getBatchSize

        public org.opendaylight.yangtools.yang.common.Uint32 getBatchSize()
      • getCreateParents

        public Boolean getCreateParents()
      • isCreateParents

        public final Boolean isCreateParents()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • 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()
      • getIsAdd

        public Boolean getIsAdd()
      • isIsAdd

        public final Boolean isIsAdd()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • isSeq

        public final Boolean isSeq()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getSleepAfter

        public org.opendaylight.yangtools.yang.common.Uint32 getSleepAfter()
      • getSleepFor

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

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

        public Boolean getTxChain()
      • isTxChain

        public final Boolean isTxChain()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • augmentation

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

        public FlowTestInputBuilder setBatchSize​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setDpnCount

        public FlowTestInputBuilder setDpnCount​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setEndTableId

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

        public FlowTestInputBuilder setFlowsPerDpn​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setSleepAfter

        public FlowTestInputBuilder setSleepAfter​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setSleepFor

        public FlowTestInputBuilder setSleepFor​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setStartTableId

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

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

        public FlowTestInputBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowTestInput>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        augmentationType - augmentation type to be removed
        this builder