Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.use.multiple.paths.neighbor.use.multiple.paths

Class EbgpBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.use.multiple.paths.neighbor.use.multiple.paths.EbgpBuilder
@Generated("mdsal-binding-generator") public class EbgpBuilder extends Object
Class that builds Ebgp 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: 

   
     Ebgp createEbgp(int fooXyzzy, int barBaz) {
         return new EbgpBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • EbgpBuilder

      public EbgpBuilder()
      Construct an empty builder.

    • EbgpBuilder

      public EbgpBuilder(Ebgp base)
      Construct a builder initialized with state from specified Ebgp.
      Parameters:
      base - Ebgp from which the builder should be initialized

  • Method Details

    • empty

      public static @NonNull Ebgp empty()
      Get empty instance of Ebgp.
      Returns:
      An empty Ebgp

    • getConfig

      public Config getConfig()
      Return current value associated with the property corresponding to Ebgp.getConfig().
      Returns:
      current value

    • getState

      public State getState()
      Return current value associated with the property corresponding to Ebgp.getState().
      Returns:
      current value

    • augmentation

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

    • setConfig

      public EbgpBuilder setConfig(Config value)
      Set the property corresponding to Ebgp.getConfig() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setState

      public EbgpBuilder setState(State value)
      Set the property corresponding to Ebgp.getState() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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