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

Class GroupModCaseDataBuilder

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

       
     GroupModCaseData createGroupModCaseData(int fooXyzzy, int barBaz) {
         return new GroupModCaseDataBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • GroupModCaseDataBuilder

        public GroupModCaseDataBuilder()
        Construct an empty builder.

      • GroupModCaseDataBuilder

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

      • GroupModCaseDataBuilder

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

      • GroupModCaseDataBuilder

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

      • GroupModCaseDataBuilder

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

    • 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:
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getGroupId

        public GroupId getGroupId()
        Return current value associated with the property corresponding to GroupMod$G.getGroupId().
        Returns:
        current value

      • getType

        public GroupType getType()
        Return current value associated with the property corresponding to GroupMod$G.getType().
        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<GroupModCaseData>> 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

      • setVersion

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