Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.nx.action.learn.grouping

Class NxActionLearnBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.nx.action.learn.grouping.NxActionLearnBuilder
@Generated("mdsal-binding-generator") public class NxActionLearnBuilder extends Object
Class that builds NxActionLearn 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: 

   
     NxActionLearn createNxActionLearn(int fooXyzzy, int barBaz) {
         return new NxActionLearnBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NxActionLearnBuilder

      public NxActionLearnBuilder()
      Construct an empty builder.

    • NxActionLearnBuilder

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

  • Method Details

    • empty

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

    • getCookie

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

    • getFinHardTimeout

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

    • getFinIdleTimeout

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

    • getFlags

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

    • getFlowMods

      public List<FlowMods> getFlowMods()
      Return current value associated with the property corresponding to NxActionLearn.getFlowMods().
      Returns:
      current value

    • getHardTimeout

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

    • getIdleTimeout

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

    • getPriority

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

    • getTableId

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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionLearn>> 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 NxActionLearnBuilder setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to NxActionLearn.getCookie() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setFinHardTimeout

      public NxActionLearnBuilder setFinHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to NxActionLearn.getFinHardTimeout() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setFinIdleTimeout

      public NxActionLearnBuilder setFinIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to NxActionLearn.getFinIdleTimeout() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setFlags

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

    • setFlowMods

      public NxActionLearnBuilder setFlowMods(List<FlowMods> values)
      Set the property corresponding to NxActionLearn.getFlowMods() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setHardTimeout

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

    • setIdleTimeout

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

    • setPriority

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

    • setTableId

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

    • addAugmentation

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