Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.procmon.rev190315.procmon.processes.top.processes

Class ProcessBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.procmon.rev190315.procmon.processes.top.processes.ProcessBuilder
@Generated("mdsal-binding-generator") public class ProcessBuilder extends Object
Class that builds Process 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: 

   
     Process createProcess(int fooXyzzy, int barBaz) {
         return new ProcessBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ProcessBuilder

      public ProcessBuilder()
      Construct an empty builder.

    • ProcessBuilder

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

  • Method Details

    • key

      public ProcessKey key()
      Return current value associated with the property corresponding to Process.key().
      Returns:
      current value

    • getPid

      public org.opendaylight.yangtools.yang.common.Uint64 getPid()
      Return current value associated with the property corresponding to Process.getPid().
      Returns:
      current value

    • getState

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

    • augmentation

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

    • withKey

      public ProcessBuilder withKey(ProcessKey key)
      Set the key value corresponding to Process.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setPid

      public ProcessBuilder setPid(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to Process.getPid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setState

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

    • addAugmentation

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