Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow._switch.connection.config.rev160506._switch.connection.config

Class ThreadsBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow._switch.connection.config.rev160506._switch.connection.config.ThreadsBuilder
@Generated("mdsal-binding-generator") public class ThreadsBuilder extends Object
Class that builds Threads 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: 

   
     Threads createThreads(int fooXyzzy, int barBaz) {
         return new ThreadsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ThreadsBuilder

      public ThreadsBuilder()
      Construct an empty builder.

    • ThreadsBuilder

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

  • Method Details

    • getBossThreads

      public org.opendaylight.yangtools.yang.common.Uint16 getBossThreads()
      Return current value associated with the property corresponding to Threads.getBossThreads().
      Returns:
      current value

    • getWorkerThreads

      public org.opendaylight.yangtools.yang.common.Uint16 getWorkerThreads()
      Return current value associated with the property corresponding to Threads.getWorkerThreads().
      Returns:
      current value

    • augmentation

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

    • setBossThreads

      public ThreadsBuilder setBossThreads(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to Threads.getBossThreads() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setWorkerThreads

      public ThreadsBuilder setWorkerThreads(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to Threads.getWorkerThreads() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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