Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.server.rev220321.pcc.configured.lsp.configured.lsp

Class IntendedPathBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.server.rev220321.pcc.configured.lsp.configured.lsp.IntendedPathBuilder
@Generated("mdsal-binding-generator") public class IntendedPathBuilder extends Object
Class that builds IntendedPath 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: 

   
     IntendedPath createIntendedPath(int fooXyzzy, int barBaz) {
         return new IntendedPathBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • IntendedPathBuilder

      public IntendedPathBuilder()
      Construct an empty builder.

    • IntendedPathBuilder

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

  • Method Details

    • empty

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

    • getConstraints

      public Constraints getConstraints()
      Return current value associated with the property corresponding to IntendedPath.getConstraints().
      Returns:
      current value

    • getDestination

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getDestination()
      Return current value associated with the property corresponding to IntendedPath.getDestination().
      Returns:
      current value

    • getSource

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getSource()
      Return current value associated with the property corresponding to IntendedPath.getSource().
      Returns:
      current value

    • augmentation

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

    • setConstraints

      public IntendedPathBuilder setConstraints(Constraints value)
      Set the property corresponding to IntendedPath.getConstraints() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setDestination

      public IntendedPathBuilder setDestination(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
      Set the property corresponding to IntendedPath.getDestination() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSource

      public IntendedPathBuilder setSource(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
      Set the property corresponding to IntendedPath.getSource() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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