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

Class BatchBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.BatchBuilder
@Generated("mdsal-binding-generator") public class BatchBuilder extends Object
Class that builds Batch 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: 

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

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

  • Constructor Details

    • BatchBuilder

      public BatchBuilder()
      Construct an empty builder.

    • BatchBuilder

      public BatchBuilder(BatchOrderGrouping arg)
      Construct a new builder initialized from specified BatchOrderGrouping.
      Parameters:
      arg - BatchOrderGrouping from which the builder should be initialized

    • BatchBuilder

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

  • Method Details

    • 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

    • key

      public BatchKey key()
      Return current value associated with the property corresponding to Batch.key().
      Returns:
      current value

    • getBatchChoice

      public BatchChoice getBatchChoice()
      Return current value associated with the property corresponding to Batch.getBatchChoice().
      Returns:
      current value

    • getBatchOrder

      public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()
      Return current value associated with the property corresponding to BatchOrderGrouping.getBatchOrder().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Batch>> 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

    • withKey

      public BatchBuilder withKey(BatchKey key)
      Set the key value corresponding to Batch.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setBatchChoice

      public BatchBuilder setBatchChoice(BatchChoice value)
      Set the property corresponding to Batch.getBatchChoice() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setBatchOrder

      public BatchBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to BatchOrderGrouping.getBatchOrder() to the specified value.
      Parameters:
      value - desired value
      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 @NonNull Batch build()
      A new Batch instance.
      Returns:
      A new Batch instance.