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

Class FlowModInputBuilder

  • @Generated("mdsal-binding-generator")
public class FlowModInputBuilder
extends Object
    Class that builds FlowModInput 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: 

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

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

    • Constructor Detail

      • FlowModInputBuilder

        public FlowModInputBuilder()
        Construct an empty builder.

      • FlowModInputBuilder

        public FlowModInputBuilder​(FlowMod$G arg)
        Construct a new builder initialized from specified FlowMod$G.
        Parameters:
        arg - FlowMod$G from which the builder should be initialized

      • FlowModInputBuilder

        public FlowModInputBuilder​(OfHeader arg)
        Construct a new builder initialized from specified OfHeader.
        Parameters:
        arg - OfHeader from which the builder should be initialized

      • FlowModInputBuilder

        public FlowModInputBuilder​(MatchGrouping arg)
        Construct a new builder initialized from specified MatchGrouping.
        Parameters:
        arg - MatchGrouping from which the builder should be initialized

      • FlowModInputBuilder

        public FlowModInputBuilder​(InstructionsGrouping arg)
        Construct a new builder initialized from specified InstructionsGrouping.
        Parameters:
        arg - InstructionsGrouping from which the builder should be initialized

      • FlowModInputBuilder

        public FlowModInputBuilder​(MatchV10Grouping arg)
        Construct a new builder initialized from specified MatchV10Grouping.
        Parameters:
        arg - MatchV10Grouping from which the builder should be initialized

      • FlowModInputBuilder

        public FlowModInputBuilder​(ActionsGrouping arg)
        Construct a new builder initialized from specified ActionsGrouping.
        Parameters:
        arg - ActionsGrouping from which the builder should be initialized

      • FlowModInputBuilder

        public FlowModInputBuilder​(FlowModInput base)
        Construct a builder initialized with state from specified FlowModInput.
        Parameters:
        base - FlowModInput from which the builder should be initialized

    • Method Detail

      • getBufferId

        public org.opendaylight.yangtools.yang.common.Uint32 getBufferId()
        Return current value associated with the property corresponding to FlowMod$G.getBufferId().
        Returns:
        current value

      • getCookie

        public org.opendaylight.yangtools.yang.common.Uint64 getCookie()
        Return current value associated with the property corresponding to FlowMod$G.getCookie().
        Returns:
        current value

      • getCookieMask

        public org.opendaylight.yangtools.yang.common.Uint64 getCookieMask()
        Return current value associated with the property corresponding to FlowMod$G.getCookieMask().
        Returns:
        current value

      • getHardTimeout

        public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
        Return current value associated with the property corresponding to FlowMod$G.getHardTimeout().
        Returns:
        current value

      • getIdleTimeout

        public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
        Return current value associated with the property corresponding to FlowMod$G.getIdleTimeout().
        Returns:
        current value

      • getMatch

        public Match getMatch()
        Return current value associated with the property corresponding to MatchGrouping.getMatch().
        Returns:
        current value

      • getOutGroup

        public org.opendaylight.yangtools.yang.common.Uint32 getOutGroup()
        Return current value associated with the property corresponding to FlowMod$G.getOutGroup().
        Returns:
        current value

      • getPriority

        public org.opendaylight.yangtools.yang.common.Uint16 getPriority()
        Return current value associated with the property corresponding to FlowMod$G.getPriority().
        Returns:
        current value

      • getTableId

        public TableId getTableId()
        Return current value associated with the property corresponding to FlowMod$G.getTableId().
        Returns:
        current value

      • getVersion

        public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
        Return current value associated with the property corresponding to OfHeader.getVersion().
        Returns:
        current value

      • getXid

        public org.opendaylight.yangtools.yang.common.Uint32 getXid()
        Return current value associated with the property corresponding to OfHeader.getXid().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModInput>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        Parameters:
        augmentationType - augmentation type class
        Returns:
        Augmentation object from this builder, or null if not present
        Throws:
        NullPointerException - if augmentType is null

      • setBufferId

        public FlowModInputBuilder setBufferId​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to FlowMod$G.getBufferId() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setCookie

        public FlowModInputBuilder setCookie​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to FlowMod$G.getCookie() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setCookieMask

        public FlowModInputBuilder setCookieMask​(org.opendaylight.yangtools.yang.common.Uint64 value)
        Set the property corresponding to FlowMod$G.getCookieMask() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setHardTimeout

        public FlowModInputBuilder setHardTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to FlowMod$G.getHardTimeout() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setIdleTimeout

        public FlowModInputBuilder setIdleTimeout​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to FlowMod$G.getIdleTimeout() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setOutGroup

        public FlowModInputBuilder setOutGroup​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to FlowMod$G.getOutGroup() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPriority

        public FlowModInputBuilder setPriority​(org.opendaylight.yangtools.yang.common.Uint16 value)
        Set the property corresponding to FlowMod$G.getPriority() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setVersion

        public FlowModInputBuilder setVersion​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to OfHeader.getVersion() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setXid

        public FlowModInputBuilder setXid​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to OfHeader.getXid() to the specified value.
        Parameters:
        value - desired value
        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