Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731

Class PacketInMessageBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessageBuilder
@Generated("mdsal-binding-generator") public class PacketInMessageBuilder extends Object
Class that builds PacketInMessage 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: 

   
     PacketInMessage createPacketInMessage(int fooXyzzy, int barBaz) {
         return new PacketInMessageBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PacketInMessageBuilder

      public PacketInMessageBuilder()
      Construct an empty builder.

    • PacketInMessageBuilder

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

    • PacketInMessageBuilder

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

    • PacketInMessageBuilder

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

    • PacketInMessageBuilder

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

    • getBufferId

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

    • getCookie

      public org.opendaylight.yangtools.yang.common.Uint64 getCookie()
      Return current value associated with the property corresponding to PacketIn.getCookie().
      Returns:
      current value

    • getData

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

    • getInPort

      public org.opendaylight.yangtools.yang.common.Uint16 getInPort()
      Return current value associated with the property corresponding to PacketIn.getInPort().
      Returns:
      current value

    • getMatch

      public Match getMatch()
      Return current value associated with the property corresponding to MatchGrouping.getMatch().
      Returns:
      current value

    • getReason

      public PacketInReason getReason()
      Return current value associated with the property corresponding to PacketIn.getReason().
      Returns:
      current value

    • getTableId

      public TableId getTableId()
      Return current value associated with the property corresponding to PacketIn.getTableId().
      Returns:
      current value

    • getTotalLen

      public org.opendaylight.yangtools.yang.common.Uint16 getTotalLen()
      Return current value associated with the property corresponding to PacketIn.getTotalLen().
      Returns:
      current value

    • getVersion

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

    • getXid

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

    • augmentation

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

    • setBufferId

      public PacketInMessageBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to PacketIn.getBufferId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setCookie

      public PacketInMessageBuilder setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to PacketIn.getCookie() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setData

      public PacketInMessageBuilder setData(byte[] value)
      Set the property corresponding to PacketIn.getData() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setInPort

      public PacketInMessageBuilder setInPort(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to PacketIn.getInPort() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMatch

      public PacketInMessageBuilder setMatch(Match value)
      Set the property corresponding to MatchGrouping.getMatch() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setReason

      public PacketInMessageBuilder setReason(PacketInReason value)
      Set the property corresponding to PacketIn.getReason() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTableId

      public PacketInMessageBuilder setTableId(TableId value)
      Set the property corresponding to PacketIn.getTableId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTotalLen

      public PacketInMessageBuilder setTotalLen(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to PacketIn.getTotalLen() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setVersion

      public PacketInMessageBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to OfHeader.getVersion() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setXid

      public PacketInMessageBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to OfHeader.getXid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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