Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.multipart.reply.multipart.reply.body

Class MultipartReplyDescBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.multipart.reply.multipart.reply.body.MultipartReplyDescBuilder
@Generated("mdsal-binding-generator") public class MultipartReplyDescBuilder extends Object
Class that builds MultipartReplyDesc 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: 

   
     MultipartReplyDesc createMultipartReplyDesc(int fooXyzzy, int barBaz) {
         return new MultipartReplyDescBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MultipartReplyDescBuilder

      public MultipartReplyDescBuilder()
      Construct an empty builder.

    • MultipartReplyDescBuilder

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

    • MultipartReplyDescBuilder

      public MultipartReplyDescBuilder(MultipartReplyDesc base)
      Construct a builder initialized with state from specified MultipartReplyDesc.
      Parameters:
      base - MultipartReplyDesc 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

    • getDescription

      public String getDescription()
      Return current value associated with the property corresponding to Desc.getDescription().
      Returns:
      current value

    • getHardware

      public String getHardware()
      Return current value associated with the property corresponding to Desc.getHardware().
      Returns:
      current value

    • getManufacturer

      public String getManufacturer()
      Return current value associated with the property corresponding to Desc.getManufacturer().
      Returns:
      current value

    • getSerialNumber

      public String getSerialNumber()
      Return current value associated with the property corresponding to Desc.getSerialNumber().
      Returns:
      current value

    • getSoftware

      public String getSoftware()
      Return current value associated with the property corresponding to Desc.getSoftware().
      Returns:
      current value

    • augmentation

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

    • setDescription

      public MultipartReplyDescBuilder setDescription(String value)
      Set the property corresponding to Desc.getDescription() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setHardware

      public MultipartReplyDescBuilder setHardware(String value)
      Set the property corresponding to Desc.getHardware() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setManufacturer

      public MultipartReplyDescBuilder setManufacturer(String value)
      Set the property corresponding to Desc.getManufacturer() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSerialNumber

      public MultipartReplyDescBuilder setSerialNumber(String value)
      Set the property corresponding to Desc.getSerialNumber() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSoftware

      public MultipartReplyDescBuilder setSoftware(String value)
      Set the property corresponding to Desc.getSoftware() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public MultipartReplyDescBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyDesc> 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 MultipartReplyDescBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyDesc>> 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 MultipartReplyDesc build()
      A new MultipartReplyDesc instance.
      Returns:
      A new MultipartReplyDesc instance.