Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.flow.mod.spec.flow.mod.spec.flow.mod.output.to.port._case

Class FlowModOutputToPortBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.flow.mod.spec.flow.mod.spec.flow.mod.output.to.port._case.FlowModOutputToPortBuilder
@Generated("mdsal-binding-generator") public class FlowModOutputToPortBuilder extends Object
Class that builds FlowModOutputToPort 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: 

   
     FlowModOutputToPort createFlowModOutputToPort(int fooXyzzy, int barBaz) {
         return new FlowModOutputToPortBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • FlowModOutputToPortBuilder

      public FlowModOutputToPortBuilder()
      Construct an empty builder.

    • FlowModOutputToPortBuilder

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

  • Method Details

    • empty

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

    • getFlowModNumBits

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

    • getSrcField

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

    • getSrcOfs

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

    • augmentation

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

    • setFlowModNumBits

      public FlowModOutputToPortBuilder setFlowModNumBits(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to FlowModOutputToPort.getFlowModNumBits() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSrcField

      public FlowModOutputToPortBuilder setSrcField(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to FlowModOutputToPort.getSrcField() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSrcOfs

      public FlowModOutputToPortBuilder setSrcOfs(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to FlowModOutputToPort.getSrcOfs() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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