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

Class MakeToastInputBuilder

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

   
     MakeToastInput createMakeToastInput(int fooXyzzy, int barBaz) {
         return new MakeToastInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MakeToastInputBuilder

      public MakeToastInputBuilder()
      Construct an empty builder.

    • MakeToastInputBuilder

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

  • Method Details

    • getToasterDoneness

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

    • getToasterToastType

      public ToastType getToasterToastType()
      Return current value associated with the property corresponding to MakeToastInput.getToasterToastType().
      Returns:
      current value

    • augmentation

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

    • setToasterDoneness

      public MakeToastInputBuilder setToasterDoneness(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to MakeToastInput.getToasterDoneness() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setToasterToastType

      public MakeToastInputBuilder setToasterToastType(ToastType value)
      Set the property corresponding to MakeToastInput.getToasterToastType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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