Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009

Class Config2Builder

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

   
     Config2 createConfig2(int fooXyzzy, int barBaz) {
         return new Config2Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Config2Builder

      public Config2Builder()
      Construct an empty builder.

    • Config2Builder

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

    • Config2Builder

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

    • getNeighborAddress

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

    • setNeighborAddress

      public Config2Builder setNeighborAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
      Set the property corresponding to BgpNeighborNeighborAddressConfig.getNeighborAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • build

      public @NonNull Config2 build()
      A new Config2 instance.
      Returns:
      A new Config2 instance.