Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.p2p.rev130819

Class TunnelTypes1Builder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.p2p.rev130819.TunnelTypes1Builder
@Generated("mdsal-binding-generator") public class TunnelTypes1Builder extends Object
Class that builds TunnelTypes1 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: 

   
     TunnelTypes1 createTunnelTypes1(int fooXyzzy, int barBaz) {
         return new TunnelTypes1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • TunnelTypes1Builder

      public TunnelTypes1Builder()
      Construct an empty builder.

    • TunnelTypes1Builder

      public TunnelTypes1Builder(TunnelP2pType arg)
      Construct a new builder initialized from specified TunnelP2pType.
      Parameters:
      arg - TunnelP2pType from which the builder should be initialized

    • TunnelTypes1Builder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
      Set fields from given grouping argument. Valid argument is instance of one of following types:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • getP2pTunnel

      public P2pTunnel getP2pTunnel()
      Return current value associated with the property corresponding to TunnelP2pType.getP2pTunnel().
      Returns:
      current value

    • setP2pTunnel

      public TunnelTypes1Builder setP2pTunnel(P2pTunnel value)
      Set the property corresponding to TunnelP2pType.getP2pTunnel() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • build

      public @NonNull TunnelTypes1 build()
      A new TunnelTypes1 instance.
      Returns:
      A new TunnelTypes1 instance.