java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.BgpBuilder

@Generated("mdsal-binding-generator") public class BgpBuilder extends Object
Class that builds Bgp 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:

   
     Bgp createBgp(int fooXyzzy, int barBaz) {
         return new BgpBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • BgpBuilder

      public BgpBuilder()
      Construct an empty builder.
    • BgpBuilder

      public BgpBuilder(Bgp base)
      Construct a builder initialized with state from specified Bgp.
      Parameters:
      base - Bgp from which the builder should be initialized
  • Method Details

    • getGlobal

      public Global getGlobal()
      Return current value associated with the property corresponding to Bgp.getGlobal().
      Returns:
      current value
    • getNeighbors

      public Neighbors getNeighbors()
      Return current value associated with the property corresponding to Bgp.getNeighbors().
      Returns:
      current value
    • getPeerGroups

      public PeerGroups getPeerGroups()
      Return current value associated with the property corresponding to Bgp.getPeerGroups().
      Returns:
      current value
    • augmentation

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

      public BgpBuilder setGlobal(Global value)
      Set the property corresponding to Bgp.getGlobal() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setNeighbors

      public BgpBuilder setNeighbors(Neighbors value)
      Set the property corresponding to Bgp.getNeighbors() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setPeerGroups

      public BgpBuilder setPeerGroups(PeerGroups value)
      Set the property corresponding to Bgp.getPeerGroups() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

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