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

Class NxActionOutputRegBuilder

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

   
     NxActionOutputReg createNxActionOutputReg(int fooXyzzy, int barBaz) {
         return new NxActionOutputRegBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NxActionOutputRegBuilder

      public NxActionOutputRegBuilder()
      Construct an empty builder.

    • NxActionOutputRegBuilder

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

  • Method Details

    • getExperimenterId

      public ExperimenterId getExperimenterId()
      Return current value associated with the property corresponding to NxActionOutputReg.getExperimenterId().
      Returns:
      current value

    • getMaxLen

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

    • getNBits

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

    • getSrc

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

    • augmentation

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

    • setExperimenterId

      public NxActionOutputRegBuilder setExperimenterId(ExperimenterId value)
      Set the property corresponding to NxActionOutputReg.getExperimenterId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMaxLen

      public NxActionOutputRegBuilder setMaxLen(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to NxActionOutputReg.getMaxLen() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNBits

      public NxActionOutputRegBuilder setNBits(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to NxActionOutputReg.getNBits() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSrc

      public NxActionOutputRegBuilder setSrc(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to NxActionOutputReg.getSrc() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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