java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.ospf.node.attributes.ospf.node.attributes.router.type.PseudonodeBuilder

@Generated("mdsal-binding-generator") public class PseudonodeBuilder extends Object
Class that builds Pseudonode 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:

   
     Pseudonode createPseudonode(int fooXyzzy, int barBaz) {
         return new PseudonodeBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • PseudonodeBuilder

      public PseudonodeBuilder()
      Construct an empty builder.
    • PseudonodeBuilder

      public PseudonodeBuilder(Pseudonode base)
      Construct a builder initialized with state from specified Pseudonode.
      Parameters:
      base - Pseudonode from which the builder should be initialized
  • Method Details

    • getPseudonode

      public org.opendaylight.yangtools.yang.common.Empty getPseudonode()
      Return current value associated with the property corresponding to Pseudonode.getPseudonode().
      Returns:
      current value
    • augmentation

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

      public PseudonodeBuilder setPseudonode(org.opendaylight.yangtools.yang.common.Empty value)
      Set the property corresponding to Pseudonode.getPseudonode() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

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