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

Class GroupModInputBuilder

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

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

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

    • Constructor Detail

      • GroupModInputBuilder

        public GroupModInputBuilder()

      • GroupModInputBuilder

        public GroupModInputBuilder​(GroupMod arg)

      • GroupModInputBuilder

        public GroupModInputBuilder​(OfHeader arg)

      • GroupModInputBuilder

        public GroupModInputBuilder​(BucketsGrouping arg)

      • GroupModInputBuilder

        public GroupModInputBuilder​(GroupModInput 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.protocol.rev130731.GroupMod
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BucketsGrouping
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getGroupId

        public GroupId getGroupId()

      • 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<GroupModInput>> E$$ augmentation​(Class<E$$> augmentationType)

      • setVersion

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

      • setXid

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

      • setXid

        @Deprecated(forRemoval=true)
public GroupModInputBuilder 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 GroupModInputBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<GroupModInput> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        NullPointerException - if augmentation is null

      • addAugmentation

        @Deprecated(forRemoval=true)
public GroupModInputBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupModInput>> augmentationType,
                                            org.opendaylight.yangtools.yang.binding.Augmentation<GroupModInput> augmentationValue)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use either addAugmentation(Augmentation) or removeAugmentation(Class) instead.
        Add or remove an augmentation to this builder's product.
        Parameters:
        augmentationType - augmentation type to be added or removed
        augmentationValue - augmentation value, null if the augmentation type should be removed
        Returns:
        this builder

      • removeAugmentation

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