Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.graceful.restart.capability

Class TablesBuilder

java.lang.Object
org.opendaylight.yangtools.binding.lib.AugmentableBuilder<Tables,TablesBuilder>
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.graceful.restart.capability.TablesBuilder
All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Mutable
@Generated("mdsal-binding-generator") public class TablesBuilder extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<Tables,TablesBuilder>
Class that builds Tables 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: 

   
     Tables createTables(int fooXyzzy, int barBaz) {
         return new TablesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • TablesBuilder

      public TablesBuilder()
      Construct an empty builder.

    • TablesBuilder

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

    • TablesBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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

    • key

      @Deprecated(forRemoval=true) public TablesKey key()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to EntryObject.key().
      Returns:
      current value

    • getAfi

      @Deprecated(forRemoval=true) public AddressFamily getAfi()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to BgpTableType.getAfi().
      Returns:
      current value

    • getAfiFlags

      @Deprecated(forRemoval=true) public Tables.AfiFlags getAfiFlags()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to Tables.getAfiFlags().
      Returns:
      current value

    • getSafi

      @Deprecated(forRemoval=true) public SubsequentAddressFamily getSafi()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to BgpTableType.getSafi().
      Returns:
      current value

    • withKey

      public TablesBuilder withKey(TablesKey key)
      Set the key value corresponding to EntryObject.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setAfi

      public TablesBuilder setAfi(AddressFamily value)
      Set the property corresponding to BgpTableType.getAfi() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setAfiFlags

      public TablesBuilder setAfiFlags(Tables.AfiFlags value)
      Set the property corresponding to Tables.getAfiFlags() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSafi

      public TablesBuilder setSafi(SubsequentAddressFamily value)
      Set the property corresponding to BgpTableType.getSafi() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • build

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