Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.requests

Class SegmentComputationBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.requests.SegmentComputationBuilder
@Generated("mdsal-binding-generator") public class SegmentComputationBuilder extends Object
Class that builds SegmentComputation 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: 

   
     SegmentComputation createSegmentComputation(int fooXyzzy, int barBaz) {
         return new SegmentComputationBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SegmentComputationBuilder

      public SegmentComputationBuilder()
      Construct an empty builder.

    • SegmentComputationBuilder

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

  • Method Details

    • empty

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

    • getP2mp

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

    • getP2p

      public P2p getP2p()
      Return current value associated with the property corresponding to SegmentComputation.getP2p().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SegmentComputation>> 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 SegmentComputationBuilder setP2mp(P2mp value)
      Set the property corresponding to SegmentComputation.getP2mp() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setP2p

      public SegmentComputationBuilder setP2p(P2p value)
      Set the property corresponding to SegmentComputation.getP2p() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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