Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities

Class AddPathCapabilityBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.AddPathCapabilityBuilder
@Generated("mdsal-binding-generator") public class AddPathCapabilityBuilder extends Object
Class that builds AddPathCapability 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: 

   
     AddPathCapability createAddPathCapability(int fooXyzzy, int barBaz) {
         return new AddPathCapabilityBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • AddPathCapabilityBuilder

      public AddPathCapabilityBuilder()
      Construct an empty builder.

    • AddPathCapabilityBuilder

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

  • Method Details

    • empty

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

    • getAddressFamilies

      public List<AddressFamilies> getAddressFamilies()
      Return current value associated with the property corresponding to AddPathCapability.getAddressFamilies().
      Returns:
      current value

    • augmentation

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

    • setAddressFamilies

      public AddPathCapabilityBuilder setAddressFamilies(List<AddressFamilies> values)
      Set the property corresponding to AddPathCapability.getAddressFamilies() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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