Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406

Class StypeOpenflowBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<StypeOpenflow>, org.opendaylight.yangtools.concepts.CheckedBuilder<StypeOpenflow,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class StypeOpenflowBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<StypeOpenflow>
    Class that builds StypeOpenflowBuilder 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: 

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

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

    • Constructor Detail

      • StypeOpenflowBuilder

        public StypeOpenflowBuilder()

      • StypeOpenflowBuilder

        public StypeOpenflowBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.InstructionList arg)

      • StypeOpenflowBuilder

        public StypeOpenflowBuilder​(StypeOpenflow 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.genius.interfacemanager.servicebinding.rev160406.ServiceOpenflowInfo
        • org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.InstructionList
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getDispatcherTableId

        public org.opendaylight.yangtools.yang.common.Uint8 getDispatcherTableId()

      • getFlowCookie

        public org.opendaylight.yangtools.yang.common.Uint64 getFlowCookie()

      • getFlowPriority

        public org.opendaylight.yangtools.yang.common.Uint16 getFlowPriority()

      • getInstruction

        public java.util.List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> getInstruction()

      • setDispatcherTableId

        public StypeOpenflowBuilder setDispatcherTableId​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setDispatcherTableId

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

      • setFlowCookie

        public StypeOpenflowBuilder setFlowCookie​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setFlowCookie

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

      • setFlowPriority

        public StypeOpenflowBuilder setFlowPriority​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setFlowPriority

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

      • setInstruction

        public StypeOpenflowBuilder setInstruction​(java.util.List<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction> values)

      • build

        public StypeOpenflow build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<StypeOpenflow>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<StypeOpenflow,​java.lang.IllegalArgumentException>