Package org.opendaylight.yang.gen.v1.sonic.gnoi.yang.rev210614.copyconfig.input

Class CopyConfigRequestBuilder

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

   
     CopyConfigRequest createCopyConfigRequest(int fooXyzzy, int barBaz) {
         return new CopyConfigRequestBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • CopyConfigRequestBuilder

      public CopyConfigRequestBuilder()
      Construct an empty builder.

    • CopyConfigRequestBuilder

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

    • CopyConfigRequestBuilder

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

    • getDestination

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

    • getOverwrite

      public Boolean getOverwrite()
      Return current value associated with the property corresponding to CopyConfigRequest.getOverwrite().
      Returns:
      current value

    • getSource

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

    • augmentation

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

    • setDestination

      public CopyConfigRequestBuilder setDestination(String value)
      Set the property corresponding to CopyConfigRequest.getDestination() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setOverwrite

      public CopyConfigRequestBuilder setOverwrite(Boolean value)
      Set the property corresponding to CopyConfigRequest.getOverwrite() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSource

      public CopyConfigRequestBuilder setSource(String value)
      Set the property corresponding to CopyConfigRequest.getSource() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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