Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.platform.anchors.top

Class CpuBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.platform.anchors.top.CpuBuilder
@Generated("mdsal-binding-generator") public class CpuBuilder extends Object
Class that builds Cpu 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: 

   
     Cpu createCpu(int fooXyzzy, int barBaz) {
         return new CpuBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • CpuBuilder

      public CpuBuilder()
      Construct an empty builder.

    • CpuBuilder

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

  • Method Details

    • empty

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

    • getConfig

      public Config getConfig()
      Return current value associated with the property corresponding to Cpu.getConfig().
      Returns:
      current value

    • getState

      public State getState()
      Return current value associated with the property corresponding to Cpu.getState().
      Returns:
      current value

    • augmentation

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

    • setConfig

      public CpuBuilder setConfig(Config value)
      Set the property corresponding to Cpu.getConfig() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setState

      public CpuBuilder setState(State value)
      Set the property corresponding to Cpu.getState() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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