java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.TunnelBuilder

@Generated("mdsal-binding-generator") public class TunnelBuilder extends Object
Class that builds Tunnel 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:

   
     Tunnel createTunnel(int fooXyzzy, int barBaz) {
         return new TunnelBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • TunnelBuilder

      public TunnelBuilder()
      Construct an empty builder.
    • TunnelBuilder

      public TunnelBuilder(Tunnel base)
      Construct a builder initialized with state from specified Tunnel.
      Parameters:
      base - Tunnel from which the builder should be initialized
  • Method Details

    • getTunnelId

      public org.opendaylight.yangtools.yang.common.Uint64 getTunnelId()
      Return current value associated with the property corresponding to Tunnel.getTunnelId().
      Returns:
      current value
    • getTunnelMask

      public org.opendaylight.yangtools.yang.common.Uint64 getTunnelMask()
      Return current value associated with the property corresponding to Tunnel.getTunnelMask().
      Returns:
      current value
    • augmentation

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

      public TunnelBuilder setTunnelId(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to Tunnel.getTunnelId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setTunnelMask

      public TunnelBuilder setTunnelMask(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to Tunnel.getTunnelMask() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

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