Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.flow._case

Class MultipartRequestFlowBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.flow._case.MultipartRequestFlowBuilder
@Generated("mdsal-binding-generator") public class MultipartRequestFlowBuilder extends Object
Class that builds MultipartRequestFlow 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: 

   
     MultipartRequestFlow createMultipartRequestFlow(int fooXyzzy, int barBaz) {
         return new MultipartRequestFlowBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MultipartRequestFlowBuilder

      public MultipartRequestFlowBuilder()
      Construct an empty builder.

    • MultipartRequestFlowBuilder

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

    • MultipartRequestFlowBuilder

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

    • MultipartRequestFlowBuilder

      public MultipartRequestFlowBuilder(MultipartRequestFlow base)
      Construct a builder initialized with state from specified MultipartRequestFlow.
      Parameters:
      base - MultipartRequestFlow 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 MultipartRequestFlow empty()
      Get empty instance of MultipartRequestFlow.
      Returns:
      An empty MultipartRequestFlow

    • getCookie

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

    • getCookieMask

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

    • getMatch

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

    • getMatchV10

      public MatchV10 getMatchV10()
      Return current value associated with the property corresponding to MatchV10Grouping.getMatchV10().
      Returns:
      current value

    • getOutGroup

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

    • getOutPort

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

    • getTableId

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

    • augmentation

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

    • setCookie

      public MultipartRequestFlowBuilder setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to MultipartRequestFlow.getCookie() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setCookieMask

      public MultipartRequestFlowBuilder setCookieMask(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to MultipartRequestFlow.getCookieMask() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMatch

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

    • setMatchV10

      public MultipartRequestFlowBuilder setMatchV10(MatchV10 value)
      Set the property corresponding to MatchV10Grouping.getMatchV10() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setOutGroup

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

    • setOutPort

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

    • setTableId

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

    • addAugmentation

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