Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pmsi.tunnel.rev200120.pmsi.tunnel.pmsi.tunnel.tunnel.identifier.rsvp.te.p2mp.lsp

Class RsvpTeP2mpLspBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pmsi.tunnel.rev200120.pmsi.tunnel.pmsi.tunnel.tunnel.identifier.rsvp.te.p2mp.lsp.RsvpTeP2mpLspBuilder
@Generated("mdsal-binding-generator") public class RsvpTeP2mpLspBuilder extends Object
Class that builds RsvpTeP2mpLsp 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: 

   
     RsvpTeP2mpLsp createRsvpTeP2mpLsp(int fooXyzzy, int barBaz) {
         return new RsvpTeP2mpLspBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • RsvpTeP2mpLspBuilder

      public RsvpTeP2mpLspBuilder()
      Construct an empty builder.

    • RsvpTeP2mpLspBuilder

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

  • Method Details

    • empty

      public static @NonNull RsvpTeP2mpLsp empty()
      Get empty instance of RsvpTeP2mpLsp.
      Returns:
      An empty RsvpTeP2mpLsp

    • getExtendedTunnelId

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getExtendedTunnelId()
      Return current value associated with the property corresponding to RsvpTeP2mpLsp.getExtendedTunnelId().
      Returns:
      current value

    • getP2mpId

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

    • getTunnelId

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

    • augmentation

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

    • setExtendedTunnelId

      public RsvpTeP2mpLspBuilder setExtendedTunnelId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
      Set the property corresponding to RsvpTeP2mpLsp.getExtendedTunnelId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setP2mpId

      public RsvpTeP2mpLspBuilder setP2mpId(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to RsvpTeP2mpLsp.getP2mpId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTunnelId

      public RsvpTeP2mpLspBuilder setTunnelId(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to RsvpTeP2mpLsp.getTunnelId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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