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

     PrefixSets createPrefixSets(int fooXyzzy, int barBaz) {
         return new PrefixSetsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())

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

    • PrefixSetsBuilder

      public PrefixSetsBuilder()
      Construct an empty builder.
    • PrefixSetsBuilder

      public PrefixSetsBuilder(PrefixSet arg)
      Construct a new builder initialized from specified PrefixSet.
      arg - from which the builder should be initialized
    • PrefixSetsBuilder

      public PrefixSetsBuilder(PrefixSets base)
      Construct a builder initialized with state from specified PrefixSets.
      base - PrefixSets 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:
      arg - grouping object
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
    • empty

      public static @NonNull PrefixSets empty()
      Get empty instance of PrefixSets.
      An empty PrefixSets
    • getPrefixSet

      public Map<PrefixSetKey,PrefixSet> getPrefixSet()
      Return current value associated with the property corresponding to PrefixSet.getPrefixSet().
      current value
    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSets>> E$$ augmentation(Class<E$$> augmentationType)
      Return the specified augmentation, if it is present in this builder.
      Type Parameters:
      E$$ - augmentation type
      augmentationType - augmentation type class
      Augmentation object from this builder, or null if not present
      NullPointerException - if augmentType is null
    • setPrefixSet

      public PrefixSetsBuilder setPrefixSet(Map<PrefixSetKey,PrefixSet> values)
      Set the property corresponding to PrefixSet.getPrefixSet() to the specified value.
      values - desired value
      this builder
    • addAugmentation

      public PrefixSetsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSets> augmentation)
      Add an augmentation to this builder's product.
      augmentation - augmentation to be added
      this builder
      NullPointerException - if augmentation is null
    • removeAugmentation

      public PrefixSetsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSets>> augmentationType)
      Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
      augmentationType - augmentation type to be removed
      this builder
    • build

      public @NonNull PrefixSets build()
      A new PrefixSets instance.
      A new PrefixSets instance.