Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family.ipv6._case

Class Ipv6Builder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family.ipv6._case.Ipv6Builder
@Generated("mdsal-binding-generator") public class Ipv6Builder extends Object
Class that builds Ipv6 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: 

   
     Ipv6 createIpv6(int fooXyzzy, int barBaz) {
         return new Ipv6Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Ipv6Builder

      public Ipv6Builder()
      Construct an empty builder.

    • Ipv6Builder

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

    • Ipv6Builder

      public Ipv6Builder(Ipv6 base)
      Construct a builder initialized with state from specified Ipv6.
      Parameters:
      base - Ipv6 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 Ipv6 empty()
      Get empty instance of Ipv6.
      Returns:
      An empty Ipv6

    • getDestinationIpv6Address

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

    • getSourceIpv6Address

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

    • augmentation

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

    • setDestinationIpv6Address

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

    • setSourceIpv6Address

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

    • addAugmentation

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