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

Class CCloseMessageBuilder

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

   
     CCloseMessage createCCloseMessage(int fooXyzzy, int barBaz) {
         return new CCloseMessageBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • CCloseMessageBuilder

      public CCloseMessageBuilder()
      Construct an empty builder.

    • CCloseMessageBuilder

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

    • CCloseMessageBuilder

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

    • CCloseMessageBuilder

      public CCloseMessageBuilder(CCloseMessage base)
      Construct a builder initialized with state from specified CCloseMessage.
      Parameters:
      base - CCloseMessage 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 CCloseMessage empty()
      Get empty instance of CCloseMessage.
      Returns:
      An empty CCloseMessage

    • getCClose

      public CClose getCClose()
      Return current value associated with the property corresponding to CloseObject.getCClose().
      Returns:
      current value

    • getVersion

      public ProtocolVersion getVersion()
      Return current value associated with the property corresponding to MessageHeader.getVersion().
      Returns:
      current value

    • augmentation

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

    • setCClose

      public CCloseMessageBuilder setCClose(CClose value)
      Set the property corresponding to CloseObject.getCClose() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setVersion

      public CCloseMessageBuilder setVersion(ProtocolVersion value)
      Set the property corresponding to MessageHeader.getVersion() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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