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

Class Icmpv6MatchBuilder

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

   
     Icmpv6Match createIcmpv6Match(int fooXyzzy, int barBaz) {
         return new Icmpv6MatchBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Icmpv6MatchBuilder

      public Icmpv6MatchBuilder()
      Construct an empty builder.

    • Icmpv6MatchBuilder

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

    • Icmpv6MatchBuilder

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

    • getIcmpv6Code

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

    • getIcmpv6Type

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

    • augmentation

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

    • setIcmpv6Code

      public Icmpv6MatchBuilder setIcmpv6Code(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to Icmpv6MatchFields.getIcmpv6Code() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIcmpv6Type

      public Icmpv6MatchBuilder setIcmpv6Type(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to Icmpv6MatchFields.getIcmpv6Type() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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