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

Class PcmonrepBuilder

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

   
     Pcmonrep createPcmonrep(int fooXyzzy, int barBaz) {
         return new PcmonrepBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PcmonrepBuilder

      public PcmonrepBuilder()
      Construct an empty builder.

    • PcmonrepBuilder

      public PcmonrepBuilder(PcmonrepMessage arg)
      Construct a new builder initialized from specified PcmonrepMessage.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.PcmonrepMessage from which the builder should be initialized

    • PcmonrepBuilder

      public PcmonrepBuilder(Message arg)
      Construct a new builder initialized from specified Message.
      Parameters:
      arg - Message from which the builder should be initialized

    • PcmonrepBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
      Set fields from given grouping argument. Valid argument is instance of one of following types:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • getPcmonrepMessage

      public PcmonrepMessage getPcmonrepMessage()
      Return current value associated with the property corresponding to PcmonrepMessage.getPcmonrepMessage().
      Returns:
      current value

    • augmentation

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

    • setPcmonrepMessage

      public PcmonrepBuilder setPcmonrepMessage(PcmonrepMessage value)
      Set the property corresponding to PcmonrepMessage.getPcmonrepMessage() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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