Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.req.missing.tlv

Class ReqMissingBuilder

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

   
     ReqMissing createReqMissing(int fooXyzzy, int barBaz) {
         return new ReqMissingBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ReqMissingBuilder

      public ReqMissingBuilder()
      Construct an empty builder.

    • ReqMissingBuilder

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

    • ReqMissingBuilder

      public ReqMissingBuilder(ReqMissing base)
      Construct a builder initialized with state from specified ReqMissing.
      Parameters:
      base - ReqMissing 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

    • empty

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

    • getRequestId

      public RequestId getRequestId()
      Return current value associated with the property corresponding to ReqMissing.getRequestId().
      Returns:
      current value

    • augmentation

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

    • setRequestId

      public ReqMissingBuilder setRequestId(RequestId value)
      Set the property corresponding to ReqMissing.getRequestId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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