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

Class PacketTypeMatchBuilder

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

   
     PacketTypeMatch createPacketTypeMatch(int fooXyzzy, int barBaz) {
         return new PacketTypeMatchBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PacketTypeMatchBuilder

      public PacketTypeMatchBuilder()
      Construct an empty builder.

    • PacketTypeMatchBuilder

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

    • PacketTypeMatchBuilder

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

    • getPacketType

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

    • augmentation

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

    • setPacketType

      public PacketTypeMatchBuilder setPacketType(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to PacketTypeFields.getPacketType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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