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

Class MldpP2mpLspBuilder

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

   
     MldpP2mpLsp createMldpP2mpLsp(int fooXyzzy, int barBaz) {
         return new MldpP2mpLspBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MldpP2mpLspBuilder

      public MldpP2mpLspBuilder()
      Construct an empty builder.

    • MldpP2mpLspBuilder

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

  • Method Details

    • empty

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

    • getAddressFamily

      public AddressFamily getAddressFamily()
      Return current value associated with the property corresponding to MldpP2mpLsp.getAddressFamily().
      Returns:
      current value

    • getOpaqueValue

      public List<OpaqueValue> getOpaqueValue()
      Return current value associated with the property corresponding to MldpP2mpLsp.getOpaqueValue().
      Returns:
      current value

    • getRootNodeAddress

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

    • augmentation

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

    • setAddressFamily

      public MldpP2mpLspBuilder setAddressFamily(AddressFamily value)
      Set the property corresponding to MldpP2mpLsp.getAddressFamily() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setOpaqueValue

      public MldpP2mpLspBuilder setOpaqueValue(List<OpaqueValue> values)
      Set the property corresponding to MldpP2mpLsp.getOpaqueValue() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setRootNodeAddress

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

    • addAugmentation

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