Class MultipartRequestFlowBuilder

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

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

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

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

      • MultipartRequestFlowBuilder

        public MultipartRequestFlowBuilder()
      • MultipartRequestFlowBuilder

        public MultipartRequestFlowBuilder​(MatchGrouping arg)
      • MultipartRequestFlowBuilder

        public MultipartRequestFlowBuilder​(MatchV10Grouping arg)
    • 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.openflow.oxm.rev150225.MatchV10Grouping
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchGrouping
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types
      • getCookie

        public org.opendaylight.yangtools.yang.common.Uint64 getCookie()
      • getCookieMask

        public org.opendaylight.yangtools.yang.common.Uint64 getCookieMask()
      • getMatch

        public Match getMatch()
      • getMatchV10

        public MatchV10 getMatchV10()
      • getOutGroup

        public org.opendaylight.yangtools.yang.common.Uint32 getOutGroup()
      • getOutPort

        public org.opendaylight.yangtools.yang.common.Uint32 getOutPort()
      • getTableId

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

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

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

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

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

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

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