Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819

Class UpdateFlowInputBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowInputBuilder
@Generated("mdsal-binding-generator") public class UpdateFlowInputBuilder extends Object
Class that builds UpdateFlowInput 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: 

   
     UpdateFlowInput createUpdateFlowInput(int fooXyzzy, int barBaz) {
         return new UpdateFlowInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • UpdateFlowInputBuilder

      public UpdateFlowInputBuilder()
      Construct an empty builder.

    • UpdateFlowInputBuilder

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

    • UpdateFlowInputBuilder

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

    • UpdateFlowInputBuilder

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

    • UpdateFlowInputBuilder

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

    • getFlowRef

      public FlowRef getFlowRef()
      Return current value associated with the property corresponding to UpdateFlowInput.getFlowRef().
      Returns:
      current value

    • getNode

      public NodeRef getNode()
      Return current value associated with the property corresponding to NodeContextRef.getNode().
      Returns:
      current value

    • getOriginalFlow

      public OriginalFlow getOriginalFlow()
      Return current value associated with the property corresponding to FlowUpdate.getOriginalFlow().
      Returns:
      current value

    • getTransactionUri

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()
      Return current value associated with the property corresponding to TransactionMetadata.getTransactionUri().
      Returns:
      current value

    • getUpdatedFlow

      public UpdatedFlow getUpdatedFlow()
      Return current value associated with the property corresponding to FlowUpdate.getUpdatedFlow().
      Returns:
      current value

    • augmentation

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

    • setFlowRef

      public UpdateFlowInputBuilder setFlowRef(FlowRef value)
      Set the property corresponding to UpdateFlowInput.getFlowRef() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNode

      public UpdateFlowInputBuilder setNode(NodeRef value)
      Set the property corresponding to NodeContextRef.getNode() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setOriginalFlow

      public UpdateFlowInputBuilder setOriginalFlow(OriginalFlow value)
      Set the property corresponding to FlowUpdate.getOriginalFlow() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTransactionUri

      public UpdateFlowInputBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
      Set the property corresponding to TransactionMetadata.getTransactionUri() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setUpdatedFlow

      public UpdateFlowInputBuilder setUpdatedFlow(UpdatedFlow value)
      Set the property corresponding to FlowUpdate.getUpdatedFlow() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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