Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ipv6.dst._case

Class Ipv6DstBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ipv6.dst._case.Ipv6DstBuilder
@Generated("mdsal-binding-generator") public class Ipv6DstBuilder extends Object
Class that builds Ipv6Dst 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: 

   
     Ipv6Dst createIpv6Dst(int fooXyzzy, int barBaz) {
         return new Ipv6DstBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Ipv6DstBuilder

      public Ipv6DstBuilder()
      Construct an empty builder.

    • Ipv6DstBuilder

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

  • Method Details

    • empty

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

    • getIpv6Address

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

    • getMask

      public byte[] getMask()
      Return current value associated with the property corresponding to Ipv6Dst.getMask().
      Returns:
      current value

    • augmentation

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

    • setIpv6Address

      public Ipv6DstBuilder setIpv6Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
      Set the property corresponding to Ipv6Dst.getIpv6Address() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMask

      public Ipv6DstBuilder setMask(byte[] value)
      Set the property corresponding to Ipv6Dst.getMask() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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