Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.bundle.flow.mod._case

Class FlowModCaseDataBuilder

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

       
     FlowModCaseData createFlowModCaseData(int fooXyzzy, int barBaz) {
         return new FlowModCaseDataBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • FlowModCaseDataBuilder

        public FlowModCaseDataBuilder()
        Construct an empty builder.

      • FlowModCaseDataBuilder

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

      • FlowModCaseDataBuilder

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

      • FlowModCaseDataBuilder

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

      • FlowModCaseDataBuilder

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

      • FlowModCaseDataBuilder

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

      • FlowModCaseDataBuilder

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

      • FlowModCaseDataBuilder

        public FlowModCaseDataBuilder​(FlowModCaseData base)
        Construct a builder initialized with state from specified FlowModCaseData.
        Parameters:
        base - FlowModCaseData 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<FlowModCaseData>> 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 FlowModCaseDataBuilder 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 FlowModCaseDataBuilder 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 FlowModCaseDataBuilder 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 FlowModCaseDataBuilder 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 FlowModCaseDataBuilder 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 FlowModCaseDataBuilder 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 FlowModCaseDataBuilder 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 FlowModCaseDataBuilder 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 FlowModCaseDataBuilder 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 FlowModCaseDataBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCaseData> 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 FlowModCaseDataBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCaseData>> 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