Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.update.message

Class NlriBuilder

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

   
     Nlri createNlri(int fooXyzzy, int barBaz) {
         return new NlriBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NlriBuilder

      public NlriBuilder()
      Construct an empty builder.

    • NlriBuilder

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

    • NlriBuilder

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

    • NlriBuilder

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

    • getPathId

      public PathId getPathId()
      Return current value associated with the property corresponding to PathIdGrouping.getPathId().
      Returns:
      current value

    • getPrefix

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix getPrefix()
      Return current value associated with the property corresponding to Ipv4PrefixAndPathId.getPrefix().
      Returns:
      current value

    • augmentation

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

    • setPathId

      public NlriBuilder setPathId(PathId value)
      Set the property corresponding to PathIdGrouping.getPathId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPrefix

      public NlriBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value)
      Set the property corresponding to Ipv4PrefixAndPathId.getPrefix() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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