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

Class PacketOutInputBuilder

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

   
     PacketOutInput createPacketOutInput(int fooXyzzy, int barBaz) {
         return new PacketOutInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PacketOutInputBuilder

      public PacketOutInputBuilder()
      Construct an empty builder.

    • PacketOutInputBuilder

      public PacketOutInputBuilder(PacketOut$G arg)
      Construct a new builder initialized from specified PacketOut$G.
      Parameters:
      arg - PacketOut$G from which the builder should be initialized

    • PacketOutInputBuilder

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

    • PacketOutInputBuilder

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

    • PacketOutInputBuilder

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

    • getAction

      public List<Action> getAction()
      Return current value associated with the property corresponding to ActionsGrouping.getAction().
      Returns:
      current value

    • getBufferId

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

    • getData

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

    • getInPort

      public PortNumber getInPort()
      Return current value associated with the property corresponding to PacketOut$G.getInPort().
      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<PacketOutInput>> 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

    • setAction

      public PacketOutInputBuilder setAction(List<Action> values)
      Set the property corresponding to ActionsGrouping.getAction() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setBufferId

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

    • setData

      public PacketOutInputBuilder setData(byte[] value)
      Set the property corresponding to PacketOut$G.getData() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setInPort

      public PacketOutInputBuilder setInPort(PortNumber value)
      Set the property corresponding to PacketOut$G.getInPort() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setVersion

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