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

Class Ipv4EroBackupBuilder

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.ipv4.ero.backup._case.Ipv4EroBackupBuilder
@Generated("mdsal-binding-generator") public class Ipv4EroBackupBuilder extends Object
Class that builds Ipv4EroBackup 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: 

   
     Ipv4EroBackup createIpv4EroBackup(int fooXyzzy, int barBaz) {
         return new Ipv4EroBackupBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Ipv4EroBackupBuilder

      public Ipv4EroBackupBuilder()
      Construct an empty builder.

    • Ipv4EroBackupBuilder

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

    • Ipv4EroBackupBuilder

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

    • Ipv4EroBackupBuilder

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

    • empty

      public static @NonNull Ipv4EroBackup empty()
      Get empty instance of Ipv4EroBackup.
      Returns:
      An empty Ipv4EroBackup

    • getAddress

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getAddress()
      Return current value associated with the property corresponding to EroIpv4Address.getAddress().
      Returns:
      current value

    • getLoose

      public Boolean getLoose()
      Return current value associated with the property corresponding to EroFlags.getLoose().
      Returns:
      current value

    • augmentation

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

    • setAddress

      public Ipv4EroBackupBuilder setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
      Set the property corresponding to EroIpv4Address.getAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLoose

      public Ipv4EroBackupBuilder setLoose(Boolean value)
      Set the property corresponding to EroFlags.getLoose() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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