Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.ted.rev131021.ted.node.attributes

Class Ipv4LocalAddressBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.ted.rev131021.ted.node.attributes.Ipv4LocalAddressBuilder
@Generated("mdsal-binding-generator") public class Ipv4LocalAddressBuilder extends Object
Class that builds Ipv4LocalAddress 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: 

   
     Ipv4LocalAddress createIpv4LocalAddress(int fooXyzzy, int barBaz) {
         return new Ipv4LocalAddressBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Ipv4LocalAddressBuilder

      public Ipv4LocalAddressBuilder()
      Construct an empty builder.

    • Ipv4LocalAddressBuilder

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

  • Method Details

    • key

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

    • getIpv4Prefix

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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4LocalAddress>> 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 Ipv4LocalAddressBuilder withKey(Ipv4LocalAddressKey key)
      Set the key value corresponding to Ipv4LocalAddress.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setIpv4Prefix

      public Ipv4LocalAddressBuilder setIpv4Prefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value)
      Set the property corresponding to Ipv4LocalAddress.getIpv4Prefix() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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