Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731

Class FlowModInputBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<FlowModInput>, org.opendaylight.yangtools.concepts.CheckedBuilder<FlowModInput,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class FlowModInputBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<FlowModInput>
    Class that builds FlowModInputBuilder 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: 

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

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

    • Constructor Detail

      • FlowModInputBuilder

        public FlowModInputBuilder()

      • FlowModInputBuilder

        public FlowModInputBuilder​(FlowMod arg)

      • FlowModInputBuilder

        public FlowModInputBuilder​(OfHeader arg)

      • FlowModInputBuilder

        public FlowModInputBuilder​(MatchGrouping arg)

      • FlowModInputBuilder

        public FlowModInputBuilder​(FlowModInput 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.openflow.oxm.rev150225.MatchV10Grouping
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchGrouping
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.ActionsGrouping
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.InstructionsGrouping
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowMod
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getBufferId

        public org.opendaylight.yangtools.yang.common.Uint32 getBufferId()

      • getCookie

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

      • getCookieMask

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

      • getHardTimeout

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

      • getIdleTimeout

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

      • getMatch

        public Match getMatch()

      • getMatchV10

        public MatchV10 getMatchV10()

      • getOutGroup

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

      • getPriority

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

      • getTableId

        public TableId getTableId()

      • getVersion

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

      • getXid

        public org.opendaylight.yangtools.yang.common.Uint32 getXid()

      • augmentation

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

      • setBufferId

        public FlowModInputBuilder setBufferId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setCookie

        public FlowModInputBuilder setCookie​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setCookieMask

        public FlowModInputBuilder setCookieMask​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setHardTimeout

        public FlowModInputBuilder setHardTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setIdleTimeout

        public FlowModInputBuilder setIdleTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setOutGroup

        public FlowModInputBuilder setOutGroup​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setPriority

        public FlowModInputBuilder setPriority​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setVersion

        public FlowModInputBuilder setVersion​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setXid

        public FlowModInputBuilder setXid​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setXid

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

      • addAugmentation

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