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

Class NxMultipathBuilder

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

   
     NxMultipath createNxMultipath(int fooXyzzy, int barBaz) {
         return new NxMultipathBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NxMultipathBuilder

      public NxMultipathBuilder()
      Construct an empty builder.

    • NxMultipathBuilder

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

  • Method Details

    • getAlgorithm

      public OfjNxMpAlgorithm getAlgorithm()
      Return current value associated with the property corresponding to NxMultipath.getAlgorithm().
      Returns:
      current value

    • getArg

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

    • getBasis

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

    • getDst

      public Dst getDst()
      Return current value associated with the property corresponding to NxMultipath.getDst().
      Returns:
      current value

    • getFields

      public OfjNxHashFields getFields()
      Return current value associated with the property corresponding to NxMultipath.getFields().
      Returns:
      current value

    • getMaxLink

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

    • augmentation

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

    • setAlgorithm

      public NxMultipathBuilder setAlgorithm(OfjNxMpAlgorithm value)
      Set the property corresponding to NxMultipath.getAlgorithm() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setArg

      public NxMultipathBuilder setArg(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to NxMultipath.getArg() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setBasis

      public NxMultipathBuilder setBasis(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to NxMultipath.getBasis() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setDst

      public NxMultipathBuilder setDst(Dst value)
      Set the property corresponding to NxMultipath.getDst() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setFields

      public NxMultipathBuilder setFields(OfjNxHashFields value)
      Set the property corresponding to NxMultipath.getFields() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMaxLink

      public NxMultipathBuilder setMaxLink(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to NxMultipath.getMaxLink() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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