Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.rev130819.network.topology.topology

Class PathsBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.rev130819.network.topology.topology.PathsBuilder
@Generated("mdsal-binding-generator") public class PathsBuilder extends Object
Class that builds Paths 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: 

   
     Paths createPaths(int fooXyzzy, int barBaz) {
         return new PathsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PathsBuilder

      public PathsBuilder()
      Construct an empty builder.

    • PathsBuilder

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

  • Method Details

    • key

      public PathsKey key()
      Return current value associated with the property corresponding to Paths.key().
      Returns:
      current value

    • getPathId

      public PathId getPathId()
      Return current value associated with the property corresponding to Paths.getPathId().
      Returns:
      current value

    • getPathTypes

      public PathTypes getPathTypes()
      Return current value associated with the property corresponding to Paths.getPathTypes().
      Returns:
      current value

    • augmentation

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

    • withKey

      public PathsBuilder withKey(PathsKey key)
      Set the key value corresponding to Paths.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setPathId

      public PathsBuilder setPathId(PathId value)
      Set the property corresponding to Paths.getPathId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPathTypes

      public PathsBuilder setPathTypes(PathTypes value)
      Set the property corresponding to Paths.getPathTypes() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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