Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720.sr.subobject.nai

Class Ipv6LocalBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720.sr.subobject.nai.Ipv6LocalBuilder
@Generated("mdsal-binding-generator") public class Ipv6LocalBuilder extends Object
Class that builds Ipv6Local 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: 

   
     Ipv6Local createIpv6Local(int fooXyzzy, int barBaz) {
         return new Ipv6LocalBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Ipv6LocalBuilder

      public Ipv6LocalBuilder()
      Construct an empty builder.

    • Ipv6LocalBuilder

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

  • Method Details

    • getLocalId

      public org.opendaylight.yangtools.yang.common.Uint32 getLocalId()
      Return current value associated with the property corresponding to Ipv6Local.getLocalId().
      Returns:
      current value

    • getLocalIpv6Address

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

    • getRemoteId

      public org.opendaylight.yangtools.yang.common.Uint32 getRemoteId()
      Return current value associated with the property corresponding to Ipv6Local.getRemoteId().
      Returns:
      current value

    • getRemoteIpv6Address

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

    • augmentation

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

    • setLocalId

      public Ipv6LocalBuilder setLocalId(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Ipv6Local.getLocalId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLocalIpv6Address

      public Ipv6LocalBuilder setLocalIpv6Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value)
      Set the property corresponding to Ipv6Local.getLocalIpv6Address() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRemoteId

      public Ipv6LocalBuilder setRemoteId(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Ipv6Local.getRemoteId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRemoteIpv6Address

      public Ipv6LocalBuilder setRemoteIpv6Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value)
      Set the property corresponding to Ipv6Local.getRemoteIpv6Address() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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