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

Class OpenflowBuilder

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

   
     Openflow createOpenflow(int fooXyzzy, int barBaz) {
         return new OpenflowBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • OpenflowBuilder

      public OpenflowBuilder()
      Construct an empty builder.

    • OpenflowBuilder

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

    • OpenflowBuilder

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

    • OpenflowBuilder

      public OpenflowBuilder(Openflow base)
      Construct a builder initialized with state from specified Openflow.
      Parameters:
      base - Openflow 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

    • empty

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

    • getAgent

      public Agent getAgent()
      Return current value associated with the property corresponding to OpenflowAgentTop.getAgent().
      Returns:
      current value

    • getControllers

      public Controllers getControllers()
      Return current value associated with the property corresponding to OpenflowControllersTop.getControllers().
      Returns:
      current value

    • augmentation

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

    • setAgent

      public OpenflowBuilder setAgent(Agent value)
      Set the property corresponding to OpenflowAgentTop.getAgent() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setControllers

      public OpenflowBuilder setControllers(Controllers value)
      Set the property corresponding to OpenflowControllersTop.getControllers() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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