Package org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918

Class GroupAddedBuilder

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

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

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

    • Constructor Detail

      • GroupAddedBuilder

        public GroupAddedBuilder()

      • GroupAddedBuilder

        public GroupAddedBuilder​(NodeGroup arg)

      • GroupAddedBuilder

        public GroupAddedBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)

      • GroupAddedBuilder

        public GroupAddedBuilder​(Group arg)

      • GroupAddedBuilder

        public GroupAddedBuilder​(GroupAdded 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.group.types.rev131018.Group
        • org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionMetadata
        • org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionAware
        • org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef
        • org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.NodeGroup
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getBarrier

        public Boolean getBarrier()

      • isBarrier

        @Deprecated(forRemoval=true)
public final Boolean isBarrier()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getBuckets

        public Buckets getBuckets()

      • getContainerName

        public String getContainerName()

      • getGroupId

        public GroupId getGroupId()

      • getGroupName

        public String getGroupName()

      • getGroupRef

        public GroupRef getGroupRef()

      • getNode

        public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef getNode()

      • getTransactionUri

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()

      • augmentation

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

      • setNode

        public GroupAddedBuilder setNode​(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)

      • setTransactionUri

        public GroupAddedBuilder setTransactionUri​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)

      • addAugmentation

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