Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.ofpact.actions.ofpact.actions.nx.action.nat._case

Class NxActionNatBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.ofpact.actions.ofpact.actions.nx.action.nat._case.NxActionNatBuilder
@Generated("mdsal-binding-generator") public class NxActionNatBuilder extends Object
Class that builds NxActionNat 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: 

   
     NxActionNat createNxActionNat(int fooXyzzy, int barBaz) {
         return new NxActionNatBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NxActionNatBuilder

      public NxActionNatBuilder()
      Construct an empty builder.

    • NxActionNatBuilder

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

  • Method Details

    • getFlags

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

    • getIpAddressMax

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpAddressMax()
      Return current value associated with the property corresponding to NxActionNat.getIpAddressMax().
      Returns:
      current value

    • getIpAddressMin

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpAddressMin()
      Return current value associated with the property corresponding to NxActionNat.getIpAddressMin().
      Returns:
      current value

    • getPortMax

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

    • getPortMin

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

    • getRangePresent

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

    • augmentation

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

    • setFlags

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

    • setIpAddressMax

      public NxActionNatBuilder setIpAddressMax(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
      Set the property corresponding to NxActionNat.getIpAddressMax() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIpAddressMin

      public NxActionNatBuilder setIpAddressMin(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
      Set the property corresponding to NxActionNat.getIpAddressMin() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPortMax

      public NxActionNatBuilder setPortMax(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to NxActionNat.getPortMax() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPortMin

      public NxActionNatBuilder setPortMin(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to NxActionNat.getPortMin() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRangePresent

      public NxActionNatBuilder setRangePresent(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to NxActionNat.getRangePresent() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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