Package org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315

Class UpdateGroupsBatchInputBuilder

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

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

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

    • Constructor Detail

      • UpdateGroupsBatchInputBuilder

        public UpdateGroupsBatchInputBuilder()

      • UpdateGroupsBatchInputBuilder

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

      • UpdateGroupsBatchInputBuilder

        public UpdateGroupsBatchInputBuilder​(BarrierSuffix arg)

    • 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.inventory.rev130819.NodeContextRef
        • org.opendaylight.yang.gen.v1.urn.opendaylight.service.barrier.common.rev160315.BarrierSuffix
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getBarrierAfter

        public Boolean getBarrierAfter()

      • isBarrierAfter

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

      • getNode

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

      • augmentation

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

      • removeAugmentation

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