Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.messages

Class MessageBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.messages.MessageBuilder
@Generated("mdsal-binding-generator") public class MessageBuilder extends Object
Class that builds Message 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: 

   
     Message createMessage(int fooXyzzy, int barBaz) {
         return new MessageBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MessageBuilder

      public MessageBuilder()
      Construct an empty builder.

    • MessageBuilder

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

    • MessageBuilder

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

    • MessageBuilder

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

    • getBundleInnerMessage

      public BundleInnerMessage getBundleInnerMessage()
      Return current value associated with the property corresponding to BundleInnerMessageGrouping.getBundleInnerMessage().
      Returns:
      current value

    • getNode

      public NodeRef getNode()
      Return current value associated with the property corresponding to NodeContextRef.getNode().
      Returns:
      current value

    • augmentation

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

    • setBundleInnerMessage

      public MessageBuilder setBundleInnerMessage(BundleInnerMessage value)
      Set the property corresponding to BundleInnerMessageGrouping.getBundleInnerMessage() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNode

      public MessageBuilder setNode(NodeRef value)
      Set the property corresponding to NodeContextRef.getNode() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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