Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.openflow.rev181121.openflow.controllers.top.controllers

Class ControllerBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.openflow.rev181121.openflow.controllers.top.controllers.ControllerBuilder
@Generated("mdsal-binding-generator") public class ControllerBuilder extends Object
Class that builds Controller 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: 

   
     Controller createController(int fooXyzzy, int barBaz) {
         return new ControllerBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ControllerBuilder

      public ControllerBuilder()
      Construct an empty builder.

    • ControllerBuilder

      public ControllerBuilder(OpenflowConnectionsTop arg)
      Construct a new builder initialized from specified OpenflowConnectionsTop.
      Parameters:
      arg - OpenflowConnectionsTop from which the builder should be initialized

    • ControllerBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
      Set fields from given grouping argument. Valid argument is instance of one of following types:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • key

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

    • getConfig

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

    • getConnections

      public Connections getConnections()
      Return current value associated with the property corresponding to OpenflowConnectionsTop.getConnections().
      Returns:
      current value

    • getName

      public String getName()
      Return current value associated with the property corresponding to Controller.getName().
      Returns:
      current value

    • getState

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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Controller>> 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 ControllerBuilder withKey(ControllerKey key)
      Set the key value corresponding to Controller.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setConfig

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

    • setConnections

      public ControllerBuilder setConnections(Connections value)
      Set the property corresponding to OpenflowConnectionsTop.getConnections() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setName

      public ControllerBuilder setName(String value)
      Set the property corresponding to Controller.getName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setState

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

    • addAugmentation

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