Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table

Class FlowBuilder

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

   
     Flow createFlow(int fooXyzzy, int barBaz) {
         return new FlowBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • FlowBuilder

      public FlowBuilder()
      Construct an empty builder.

    • FlowBuilder

      public FlowBuilder(Flow arg)
      Construct a new builder initialized from specified Flow.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.Flow from which the builder should be initialized

    • FlowBuilder

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

    • FlowBuilder

      public FlowBuilder(Flow base)
      Construct a builder initialized with state from specified Flow.
      Parameters:
      base - Flow 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 FlowKey key()
      Return current value associated with the property corresponding to Flow.key().
      Returns:
      current value

    • getBarrier

      public Boolean getBarrier()
      Return current value associated with the property corresponding to Flow.getBarrier().
      Returns:
      current value

    • getBufferId

      public org.opendaylight.yangtools.yang.common.Uint32 getBufferId()
      Return current value associated with the property corresponding to Flow.getBufferId().
      Returns:
      current value

    • getContainerName

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

    • getCookie

      public FlowCookie getCookie()
      Return current value associated with the property corresponding to GenericFlowAttributes.getCookie().
      Returns:
      current value

    • getCookieMask

      public FlowCookie getCookieMask()
      Return current value associated with the property corresponding to Flow.getCookieMask().
      Returns:
      current value

    • getFlags

      public FlowModFlags getFlags()
      Return current value associated with the property corresponding to Flow.getFlags().
      Returns:
      current value

    • getFlowName

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

    • getHardTimeout

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

    • getId

      public FlowId getId()
      Return current value associated with the property corresponding to Flow.getId().
      Returns:
      current value

    • getIdleTimeout

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

    • getInstallHw

      public Boolean getInstallHw()
      Return current value associated with the property corresponding to Flow.getInstallHw().
      Returns:
      current value

    • getInstructions

      public Instructions getInstructions()
      Return current value associated with the property corresponding to Flow.getInstructions().
      Returns:
      current value

    • getMatch

      public Match getMatch()
      Return current value associated with the property corresponding to Flow.getMatch().
      Returns:
      current value

    • getOutGroup

      public org.opendaylight.yangtools.yang.common.Uint32 getOutGroup()
      Return current value associated with the property corresponding to Flow.getOutGroup().
      Returns:
      current value

    • getOutPort

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

    • getPriority

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

    • getStrict

      public Boolean getStrict()
      Return current value associated with the property corresponding to Flow.getStrict().
      Returns:
      current value

    • getTableId

      public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
      Return current value associated with the property corresponding to GenericFlowAttributes.getTableId().
      Returns:
      current value

    • augmentation

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

    • setBarrier

      public FlowBuilder setBarrier(Boolean value)
      Set the property corresponding to Flow.getBarrier() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setBufferId

      public FlowBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Flow.getBufferId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setContainerName

      public FlowBuilder setContainerName(String value)
      Set the property corresponding to Flow.getContainerName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setCookie

      public FlowBuilder setCookie(FlowCookie value)
      Set the property corresponding to GenericFlowAttributes.getCookie() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setCookieMask

      public FlowBuilder setCookieMask(FlowCookie value)
      Set the property corresponding to Flow.getCookieMask() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setFlags

      public FlowBuilder setFlags(FlowModFlags value)
      Set the property corresponding to Flow.getFlags() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setFlowName

      public FlowBuilder setFlowName(String value)
      Set the property corresponding to Flow.getFlowName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setHardTimeout

      public FlowBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to GenericFlowAttributes.getHardTimeout() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setId

      public FlowBuilder setId(FlowId value)
      Set the property corresponding to Flow.getId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIdleTimeout

      public FlowBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to GenericFlowAttributes.getIdleTimeout() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setInstallHw

      public FlowBuilder setInstallHw(Boolean value)
      Set the property corresponding to Flow.getInstallHw() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setInstructions

      public FlowBuilder setInstructions(Instructions value)
      Set the property corresponding to Flow.getInstructions() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMatch

      public FlowBuilder setMatch(Match value)
      Set the property corresponding to Flow.getMatch() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setOutGroup

      public FlowBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Flow.getOutGroup() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setOutPort

      public FlowBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to Flow.getOutPort() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPriority

      public FlowBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to GenericFlowAttributes.getPriority() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setStrict

      public FlowBuilder setStrict(Boolean value)
      Set the property corresponding to Flow.getStrict() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTableId

      public FlowBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to GenericFlowAttributes.getTableId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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