java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pmsi.tunnel.rev200120.pmsi.tunnel.pmsi.tunnel.tunnel.identifier.mldp.mp2mp.lsp.MldpMp2mpLspBuilder

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

   
     MldpMp2mpLsp createMldpMp2mpLsp(int fooXyzzy, int barBaz) {
         return new MldpMp2mpLspBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • MldpMp2mpLspBuilder

      public MldpMp2mpLspBuilder()
      Construct an empty builder.
    • MldpMp2mpLspBuilder

      public MldpMp2mpLspBuilder(Opaque arg)
      Construct a new builder initialized from specified Opaque.
      Parameters:
      arg - Opaque from which the builder should be initialized
    • MldpMp2mpLspBuilder

      public MldpMp2mpLspBuilder(MldpMp2mpLsp base)
      Construct a builder initialized with state from specified MldpMp2mpLsp.
      Parameters:
      base - MldpMp2mpLsp 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
    • empty

      public static @NonNull MldpMp2mpLsp empty()
      Get empty instance of MldpMp2mpLsp.
      Returns:
      An empty MldpMp2mpLsp
    • getOpaque

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.HexString getOpaque()
      Return current value associated with the property corresponding to Opaque.getOpaque().
      Returns:
      current value
    • getOpaqueExtendedType

      public org.opendaylight.yangtools.yang.common.Uint16 getOpaqueExtendedType()
      Return current value associated with the property corresponding to Opaque.getOpaqueExtendedType().
      Returns:
      current value
    • getOpaqueType

      public org.opendaylight.yangtools.yang.common.Uint8 getOpaqueType()
      Return current value associated with the property corresponding to Opaque.getOpaqueType().
      Returns:
      current value
    • augmentation

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

      public MldpMp2mpLspBuilder setOpaque(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.HexString value)
      Set the property corresponding to Opaque.getOpaque() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setOpaqueExtendedType

      public MldpMp2mpLspBuilder setOpaqueExtendedType(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to Opaque.getOpaqueExtendedType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setOpaqueType

      public MldpMp2mpLspBuilder setOpaqueType(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to Opaque.getOpaqueType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

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