Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329

Class ApplicationRibBuilder

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

   
     ApplicationRib createApplicationRib(int fooXyzzy, int barBaz) {
         return new ApplicationRibBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ApplicationRibBuilder

      public ApplicationRibBuilder()
      Construct an empty builder.

    • ApplicationRibBuilder

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

    • ApplicationRibBuilder

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

    • key

      public ApplicationRibKey key()
      Return current value associated with the property corresponding to ApplicationRib.key().
      Returns:
      current value

    • getId

      public ApplicationRibId getId()
      Return current value associated with the property corresponding to ApplicationRib.getId().
      Returns:
      current value

    • getTables

      public Map<TablesKey,Tables> getTables()
      Return current value associated with the property corresponding to Rib.getTables().
      Returns:
      current value

    • augmentation

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

    • withKey

      public ApplicationRibBuilder withKey(ApplicationRibKey key)
      Set the key value corresponding to ApplicationRib.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setId

      public ApplicationRibBuilder setId(ApplicationRibId value)
      Set the property corresponding to ApplicationRib.getId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTables

      public ApplicationRibBuilder setTables(Map<TablesKey,Tables> values)
      Set the property corresponding to Rib.getTables() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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