Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.vs.tlv

Class VsTlvBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.vs.tlv.VsTlvBuilder
@Deprecated(forRemoval=true) @Generated("mdsal-binding-generator") public class VsTlvBuilder extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
Class that builds VsTlv 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: 

   
     VsTlv createVsTlv(int fooXyzzy, int barBaz) {
         return new VsTlvBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    Constructors
    Constructor
    Description
    VsTlvBuilder()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Construct an empty builder.
    VsTlvBuilder(VsTlv base)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Construct a builder initialized with state from specified VsTlv.

  • Method Summary

    Modifier and Type
    Method
    Description
    VsTlvBuilder
    addAugmentation(org.opendaylight.yangtools.binding.Augmentation<VsTlv> augmentation)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Add an augmentation to this builder's product.
    <E$$ extends org.opendaylight.yangtools.binding.Augmentation<VsTlv>>
    E$$
    augmentation(Class<E$$> augmentationType)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the specified augmentation, if it is present in this builder.
    @NonNull VsTlv
    build()
    Deprecated, for removal: This API element is subject to removal in a future version.
    A new VsTlv instance.
    static @NonNull VsTlv
    empty()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get empty instance of VsTlv.
    EnterpriseNumber
    getEnterpriseNumber()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return current value associated with the property corresponding to VsTlv.getEnterpriseNumber().
    VendorPayload
    getVendorPayload()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return current value associated with the property corresponding to VsTlv.getVendorPayload().
    VsTlvBuilder
    removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<VsTlv>> augmentationType)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Remove an augmentation from this builder's product.
    VsTlvBuilder
    setEnterpriseNumber(EnterpriseNumber value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the property corresponding to VsTlv.getEnterpriseNumber() to the specified value.
    VsTlvBuilder
    setVendorPayload(VendorPayload value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the property corresponding to VsTlv.getVendorPayload() to the specified value.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • VsTlvBuilder

      public VsTlvBuilder()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Construct an empty builder.

    • VsTlvBuilder

      public VsTlvBuilder(VsTlv base)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Construct a builder initialized with state from specified VsTlv.
      Parameters:
      base - VsTlv from which the builder should be initialized

  • Method Details

    • empty

      public static @NonNull VsTlv empty()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get empty instance of VsTlv.
      Returns:
      An empty VsTlv

    • getEnterpriseNumber

      public EnterpriseNumber getEnterpriseNumber()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return current value associated with the property corresponding to VsTlv.getEnterpriseNumber().
      Returns:
      current value

    • getVendorPayload

      public VendorPayload getVendorPayload()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return current value associated with the property corresponding to VsTlv.getVendorPayload().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<VsTlv>> E$$ augmentation(Class<E$$> augmentationType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

    • setEnterpriseNumber

      public VsTlvBuilder setEnterpriseNumber(EnterpriseNumber value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the property corresponding to VsTlv.getEnterpriseNumber() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setVendorPayload

      public VsTlvBuilder setVendorPayload(VendorPayload value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the property corresponding to VsTlv.getVendorPayload() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public VsTlvBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<VsTlv> augmentation)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 VsTlvBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<VsTlv>> augmentationType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 VsTlv build()
      Deprecated, for removal: This API element is subject to removal in a future version.
      A new VsTlv instance.
      Returns:
      A new VsTlv instance.