Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.object.type

Class PrefixCaseBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.object.type.PrefixCaseBuilder
@Generated("mdsal-binding-generator") public class PrefixCaseBuilder extends Object
Class that builds PrefixCase 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: 

   
     PrefixCase createPrefixCase(int fooXyzzy, int barBaz) {
         return new PrefixCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PrefixCaseBuilder

      public PrefixCaseBuilder()
      Construct an empty builder.

    • PrefixCaseBuilder

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

  • Method Details

    • getAdvertisingNodeDescriptors

      public AdvertisingNodeDescriptors getAdvertisingNodeDescriptors()
      Return current value associated with the property corresponding to PrefixCase.getAdvertisingNodeDescriptors().
      Returns:
      current value

    • getPrefixDescriptors

      public PrefixDescriptors getPrefixDescriptors()
      Return current value associated with the property corresponding to PrefixCase.getPrefixDescriptors().
      Returns:
      current value

    • augmentation

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

    • setAdvertisingNodeDescriptors

      public PrefixCaseBuilder setAdvertisingNodeDescriptors(AdvertisingNodeDescriptors value)
      Set the property corresponding to PrefixCase.getAdvertisingNodeDescriptors() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPrefixDescriptors

      public PrefixCaseBuilder setPrefixDescriptors(PrefixDescriptors value)
      Set the property corresponding to PrefixCase.getPrefixDescriptors() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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