Package org.opendaylight.yang.gen.v1.sonic.gnoi.yang.rev210614.imagedefault.output

Class ImageDefaultResponseBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.sonic.gnoi.yang.rev210614.imagedefault.output.ImageDefaultResponseBuilder
@Generated("mdsal-binding-generator") public class ImageDefaultResponseBuilder extends Object
Class that builds ImageDefaultResponse 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: 

   
     ImageDefaultResponse createImageDefaultResponse(int fooXyzzy, int barBaz) {
         return new ImageDefaultResponseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ImageDefaultResponseBuilder

      public ImageDefaultResponseBuilder()
      Construct an empty builder.

    • ImageDefaultResponseBuilder

      public ImageDefaultResponseBuilder(ImageDefaultResponse arg)
      Construct a new builder initialized from specified ImageDefaultResponse.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.sonic.gnoi.yang.rev210614.ImageDefaultResponse from which the builder should be initialized

    • ImageDefaultResponseBuilder

      public ImageDefaultResponseBuilder(SonicOutput arg)
      Construct a new builder initialized from specified SonicOutput.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.sonic.gnoi.yang.rev210614.SonicOutput from which the builder should be initialized

    • ImageDefaultResponseBuilder

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

    • empty

      public static @NonNull ImageDefaultResponse empty()
      Get empty instance of ImageDefaultResponse.
      Returns:
      An empty ImageDefaultResponse

    • getSonicOutput

      public SonicOutput getSonicOutput()
      Return current value associated with the property corresponding to SonicOutput.getSonicOutput().
      Returns:
      current value

    • augmentation

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

    • setSonicOutput

      public ImageDefaultResponseBuilder setSonicOutput(SonicOutput value)
      Set the property corresponding to SonicOutput.getSonicOutput() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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