Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match

Class Ipv6MatchBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6MatchBuilder
@Generated("mdsal-binding-generator") public class Ipv6MatchBuilder extends Object
Class that builds Ipv6Match 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: 

   
     Ipv6Match createIpv6Match(int fooXyzzy, int barBaz) {
         return new Ipv6MatchBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Ipv6MatchBuilder

      public Ipv6MatchBuilder()
      Construct an empty builder.

    • Ipv6MatchBuilder

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

    • Ipv6MatchBuilder

      public Ipv6MatchBuilder(Ipv6Match base)
      Construct a builder initialized with state from specified Ipv6Match.
      Parameters:
      base - Ipv6Match 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

    • getIpv6Destination

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

    • getIpv6ExtHeader

      public Ipv6ExtHeader getIpv6ExtHeader()
      Return current value associated with the property corresponding to Ipv6MatchFields.getIpv6ExtHeader().
      Returns:
      current value

    • getIpv6Label

      public Ipv6Label getIpv6Label()
      Return current value associated with the property corresponding to Ipv6MatchFields.getIpv6Label().
      Returns:
      current value

    • getIpv6NdSll

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getIpv6NdSll()
      Return current value associated with the property corresponding to Ipv6MatchFields.getIpv6NdSll().
      Returns:
      current value

    • getIpv6NdTarget

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

    • getIpv6NdTll

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getIpv6NdTll()
      Return current value associated with the property corresponding to Ipv6MatchFields.getIpv6NdTll().
      Returns:
      current value

    • getIpv6Source

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

    • augmentation

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

    • setIpv6Destination

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

    • setIpv6ExtHeader

      public Ipv6MatchBuilder setIpv6ExtHeader(Ipv6ExtHeader value)
      Set the property corresponding to Ipv6MatchFields.getIpv6ExtHeader() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIpv6Label

      public Ipv6MatchBuilder setIpv6Label(Ipv6Label value)
      Set the property corresponding to Ipv6MatchFields.getIpv6Label() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIpv6NdSll

      public Ipv6MatchBuilder setIpv6NdSll(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
      Set the property corresponding to Ipv6MatchFields.getIpv6NdSll() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIpv6NdTarget

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

    • setIpv6NdTll

      public Ipv6MatchBuilder setIpv6NdTll(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
      Set the property corresponding to Ipv6MatchFields.getIpv6NdTll() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIpv6Source

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

    • addAugmentation

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