Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.conntrack.grouping

Class NxConntrackBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.conntrack.grouping.NxConntrackBuilder
@Generated("mdsal-binding-generator") public class NxConntrackBuilder extends Object
Class that builds NxConntrack 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: 

   
     NxConntrack createNxConntrack(int fooXyzzy, int barBaz) {
         return new NxConntrackBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NxConntrackBuilder

      public NxConntrackBuilder()
      Construct an empty builder.

    • NxConntrackBuilder

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

  • Method Details

    • empty

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

    • getConntrackZone

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

    • getCtActions

      public List<CtActions> getCtActions()
      Return current value associated with the property corresponding to NxConntrack.getCtActions().
      Returns:
      current value

    • getFlags

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

    • getRecircTable

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

    • getZoneSrc

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

    • augmentation

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

    • setConntrackZone

      public NxConntrackBuilder setConntrackZone(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to NxConntrack.getConntrackZone() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setCtActions

      public NxConntrackBuilder setCtActions(List<CtActions> values)
      Set the property corresponding to NxConntrack.getCtActions() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setFlags

      public NxConntrackBuilder setFlags(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to NxConntrack.getFlags() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRecircTable

      public NxConntrackBuilder setRecircTable(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to NxConntrack.getRecircTable() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setZoneSrc

      public NxConntrackBuilder setZoneSrc(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to NxConntrack.getZoneSrc() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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