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

     BgpPrefixSid createBgpPrefixSid(int fooXyzzy, int barBaz) {
         return new BgpPrefixSidBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())

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

    • BgpPrefixSidBuilder

      public BgpPrefixSidBuilder()
      Construct an empty builder.
    • BgpPrefixSidBuilder

      public BgpPrefixSidBuilder(BgpPrefixSid base)
      Construct a builder initialized with state from specified BgpPrefixSid.
      base - BgpPrefixSid from which the builder should be initialized
  • Method Details

    • empty

      public static @NonNull BgpPrefixSid empty()
      Get empty instance of BgpPrefixSid.
      An empty BgpPrefixSid
    • getBgpPrefixSidTlvs

      public List<BgpPrefixSidTlvs> getBgpPrefixSidTlvs()
      Return current value associated with the property corresponding to BgpPrefixSid.getBgpPrefixSidTlvs().
      current value
    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpPrefixSid>> E$$ augmentation(Class<E$$> augmentationType)
      Return the specified augmentation, if it is present in this builder.
      Type Parameters:
      E$$ - augmentation type
      augmentationType - augmentation type class
      Augmentation object from this builder, or null if not present
      NullPointerException - if augmentType is null
    • setBgpPrefixSidTlvs

      public BgpPrefixSidBuilder setBgpPrefixSidTlvs(List<BgpPrefixSidTlvs> values)
      Set the property corresponding to BgpPrefixSid.getBgpPrefixSidTlvs() to the specified value.
      values - desired value
      this builder
    • addAugmentation

      public BgpPrefixSidBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpPrefixSid> augmentation)
      Add an augmentation to this builder's product.
      augmentation - augmentation to be added
      this builder
      NullPointerException - if augmentation is null
    • removeAugmentation

      public BgpPrefixSidBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpPrefixSid>> augmentationType)
      Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
      augmentationType - augmentation type to be removed
      this builder
    • build

      public @NonNull BgpPrefixSid build()
      A new BgpPrefixSid instance.
      A new BgpPrefixSid instance.