Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev200720.lsp.db.version.tlv

Class LspDbVersionBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev200720.lsp.db.version.tlv.LspDbVersionBuilder
@Generated("mdsal-binding-generator") public class LspDbVersionBuilder extends Object
Class that builds LspDbVersion 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: 

   
     LspDbVersion createLspDbVersion(int fooXyzzy, int barBaz) {
         return new LspDbVersionBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • LspDbVersionBuilder

      public LspDbVersionBuilder()
      Construct an empty builder.

    • LspDbVersionBuilder

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

    • LspDbVersionBuilder

      public LspDbVersionBuilder(LspDbVersion base)
      Construct a builder initialized with state from specified LspDbVersion.
      Parameters:
      base - LspDbVersion 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 LspDbVersion empty()
      Get empty instance of LspDbVersion.
      Returns:
      An empty LspDbVersion

    • getLspDbVersionValue

      public org.opendaylight.yangtools.yang.common.Uint64 getLspDbVersionValue()
      Return current value associated with the property corresponding to LspDbVersion.getLspDbVersionValue().
      Returns:
      current value

    • augmentation

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

    • setLspDbVersionValue

      public LspDbVersionBuilder setLspDbVersionValue(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to LspDbVersion.getLspDbVersionValue() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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