Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.pcep.topology.provider.rev230115.network.topology.topology.topology.types.topology.pcep

Class CapabilitiesBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.pcep.topology.provider.rev230115.network.topology.topology.topology.types.topology.pcep.CapabilitiesBuilder
@Generated("mdsal-binding-generator") public class CapabilitiesBuilder extends Object
Class that builds Capabilities 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: 

   
     Capabilities createCapabilities(int fooXyzzy, int barBaz) {
         return new CapabilitiesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • CapabilitiesBuilder

      public CapabilitiesBuilder()
      Construct an empty builder.

    • CapabilitiesBuilder

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

  • Method Details

    • empty

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

    • getP2mp

      public P2mp getP2mp()
      Return current value associated with the property corresponding to Capabilities.getP2mp().
      Returns:
      current value

    • getSegmentRouting

      public SegmentRouting getSegmentRouting()
      Return current value associated with the property corresponding to Capabilities.getSegmentRouting().
      Returns:
      current value

    • getStateful

      public Stateful getStateful()
      Return current value associated with the property corresponding to Capabilities.getStateful().
      Returns:
      current value

    • augmentation

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

    • setP2mp

      public CapabilitiesBuilder setP2mp(P2mp value)
      Set the property corresponding to Capabilities.getP2mp() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSegmentRouting

      public CapabilitiesBuilder setSegmentRouting(SegmentRouting value)
      Set the property corresponding to Capabilities.getSegmentRouting() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setStateful

      public CapabilitiesBuilder setStateful(Stateful value)
      Set the property corresponding to Capabilities.getStateful() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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