Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev200120.binding.sub.tlvs.binding.sub.tlv

Class Ipv4EroBackupCaseBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev200120.binding.sub.tlvs.binding.sub.tlv.Ipv4EroBackupCaseBuilder
@Generated("mdsal-binding-generator") public class Ipv4EroBackupCaseBuilder extends Object
Class that builds Ipv4EroBackupCase 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: 

   
     Ipv4EroBackupCase createIpv4EroBackupCase(int fooXyzzy, int barBaz) {
         return new Ipv4EroBackupCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Ipv4EroBackupCaseBuilder

      public Ipv4EroBackupCaseBuilder()
      Construct an empty builder.

    • Ipv4EroBackupCaseBuilder

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

  • Method Details

    • getIpv4EroBackup

      public Ipv4EroBackup getIpv4EroBackup()
      Return current value associated with the property corresponding to Ipv4EroBackupCase.getIpv4EroBackup().
      Returns:
      current value

    • augmentation

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

    • setIpv4EroBackup

      public Ipv4EroBackupCaseBuilder setIpv4EroBackup(Ipv4EroBackup value)
      Set the property corresponding to Ipv4EroBackupCase.getIpv4EroBackup() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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