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

Class Ipv6LocalAddressBuilder

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

   
     Ipv6LocalAddress createIpv6LocalAddress(int fooXyzzy, int barBaz) {
         return new Ipv6LocalAddressBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Ipv6LocalAddressBuilder

      public Ipv6LocalAddressBuilder()
      Construct an empty builder.

    • Ipv6LocalAddressBuilder

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

  • Method Details

    • key

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

    • getIpv6Prefix

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

    • getPrefixOption

      public org.opendaylight.yangtools.yang.common.Uint8 getPrefixOption()
      Return current value associated with the property corresponding to Ipv6LocalAddress.getPrefixOption().
      Returns:
      current value

    • augmentation

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

    • setIpv6Prefix

      public Ipv6LocalAddressBuilder setIpv6Prefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
      Set the property corresponding to Ipv6LocalAddress.getIpv6Prefix() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPrefixOption

      public Ipv6LocalAddressBuilder setPrefixOption(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to Ipv6LocalAddress.getPrefixOption() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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