Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.nsh.ttl.grouping

Class NxmNxNshTtlBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.nsh.ttl.grouping.NxmNxNshTtlBuilder
@Generated("mdsal-binding-generator") public class NxmNxNshTtlBuilder extends Object
Class that builds NxmNxNshTtl 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: 

   
     NxmNxNshTtl createNxmNxNshTtl(int fooXyzzy, int barBaz) {
         return new NxmNxNshTtlBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NxmNxNshTtlBuilder

      public NxmNxNshTtlBuilder()
      Construct an empty builder.

    • NxmNxNshTtlBuilder

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

  • Method Details

    • getNshTtl

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

    • augmentation

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

    • setNshTtl

      public NxmNxNshTtlBuilder setNshTtl(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to NxmNxNshTtl.getNshTtl() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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