Package org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120

Class ToasterBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120.ToasterBuilder
@Generated("mdsal-binding-generator") public class ToasterBuilder extends Object
Class that builds Toaster 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: 

   
     Toaster createToaster(int fooXyzzy, int barBaz) {
         return new ToasterBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ToasterBuilder

      public ToasterBuilder()
      Construct an empty builder.

    • ToasterBuilder

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

  • Method Details

    • getDarknessFactor

      public org.opendaylight.yangtools.yang.common.Uint32 getDarknessFactor()
      Return current value associated with the property corresponding to Toaster.getDarknessFactor().
      Returns:
      current value

    • getToasterManufacturer

      public DisplayString getToasterManufacturer()
      Return current value associated with the property corresponding to Toaster.getToasterManufacturer().
      Returns:
      current value

    • getToasterModelNumber

      public DisplayString getToasterModelNumber()
      Return current value associated with the property corresponding to Toaster.getToasterModelNumber().
      Returns:
      current value

    • getToasterStatus

      public Toaster.ToasterStatus getToasterStatus()
      Return current value associated with the property corresponding to Toaster.getToasterStatus().
      Returns:
      current value

    • augmentation

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

    • setDarknessFactor

      public ToasterBuilder setDarknessFactor(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Toaster.getDarknessFactor() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setToasterManufacturer

      public ToasterBuilder setToasterManufacturer(DisplayString value)
      Set the property corresponding to Toaster.getToasterManufacturer() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setToasterModelNumber

      public ToasterBuilder setToasterModelNumber(DisplayString value)
      Set the property corresponding to Toaster.getToasterModelNumber() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setToasterStatus

      public ToasterBuilder setToasterStatus(Toaster.ToasterStatus value)
      Set the property corresponding to Toaster.getToasterStatus() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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