Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.route.monitoring.message

Class UpdateBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.route.monitoring.message.UpdateBuilder
@Generated("mdsal-binding-generator") public class UpdateBuilder extends Object
Class that builds Update 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: 

   
     Update createUpdate(int fooXyzzy, int barBaz) {
         return new UpdateBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • UpdateBuilder

      public UpdateBuilder()
      Construct an empty builder.

    • UpdateBuilder

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

    • UpdateBuilder

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

    • UpdateBuilder

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

    • getAttributes

      public Attributes getAttributes()
      Return current value associated with the property corresponding to PathAttributes.getAttributes().
      Returns:
      current value

    • getNlri

      public List<Nlri> getNlri()
      Return current value associated with the property corresponding to UpdateMessage.getNlri().
      Returns:
      current value

    • getWithdrawnRoutes

      public List<WithdrawnRoutes> getWithdrawnRoutes()
      Return current value associated with the property corresponding to UpdateMessage.getWithdrawnRoutes().
      Returns:
      current value

    • augmentation

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

    • setAttributes

      public UpdateBuilder setAttributes(Attributes value)
      Set the property corresponding to PathAttributes.getAttributes() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNlri

      public UpdateBuilder setNlri(List<Nlri> values)
      Set the property corresponding to UpdateMessage.getNlri() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setWithdrawnRoutes

      public UpdateBuilder setWithdrawnRoutes(List<WithdrawnRoutes> values)
      Set the property corresponding to UpdateMessage.getWithdrawnRoutes() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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