Package org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input

Class BatchBuilder

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

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

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

    • Constructor Detail

      • BatchBuilder

        public BatchBuilder()

      • BatchBuilder

        public BatchBuilder​(Batch 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.service.batch.common.rev160322.BatchOrderGrouping
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getBatchOrder

        public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()

      • augmentation

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

      • setBatchOrder

        public BatchBuilder setBatchOrder​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setBatchOrder

        @Deprecated(forRemoval=true)
public BatchBuilder setBatchOrder​(Integer value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setBatchOrder(Uint16) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • addAugmentation

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

      • build

        public Batch build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Batch>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Batch,​IllegalArgumentException>