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

Class FlowRemovedMessageBuilder

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

   
     FlowRemovedMessage createFlowRemovedMessage(int fooXyzzy, int barBaz) {
         return new FlowRemovedMessageBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • FlowRemovedMessageBuilder

      public FlowRemovedMessageBuilder()
      Construct an empty builder.

    • FlowRemovedMessageBuilder

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

    • FlowRemovedMessageBuilder

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

    • FlowRemovedMessageBuilder

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

    • FlowRemovedMessageBuilder

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

    • FlowRemovedMessageBuilder

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

    • getByteCount

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

    • getCookie

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

    • getDurationNsec

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

    • getDurationSec

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

    • getHardTimeout

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

    • getIdleTimeout

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

    • getMatch

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

    • getMatchV10

      public MatchV10 getMatchV10()
      Return current value associated with the property corresponding to MatchV10Grouping.getMatchV10().
      Returns:
      current value

    • getPacketCount

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

    • getPriority

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

    • getReason

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

    • getTableId

      public TableId getTableId()
      Return current value associated with the property corresponding to FlowRemoved.getTableId().
      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<FlowRemovedMessage>> 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

    • setByteCount

      public FlowRemovedMessageBuilder setByteCount(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to FlowRemoved.getByteCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setCookie

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

    • setDurationNsec

      public FlowRemovedMessageBuilder setDurationNsec(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to FlowRemoved.getDurationNsec() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setDurationSec

      public FlowRemovedMessageBuilder setDurationSec(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to FlowRemoved.getDurationSec() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setHardTimeout

      public FlowRemovedMessageBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to FlowRemoved.getHardTimeout() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIdleTimeout

      public FlowRemovedMessageBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to FlowRemoved.getIdleTimeout() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMatch

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

    • setMatchV10

      public FlowRemovedMessageBuilder setMatchV10(MatchV10 value)
      Set the property corresponding to MatchV10Grouping.getMatchV10() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPacketCount

      public FlowRemovedMessageBuilder setPacketCount(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to FlowRemoved.getPacketCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPriority

      public FlowRemovedMessageBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to FlowRemoved.getPriority() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setReason

      public FlowRemovedMessageBuilder setReason(FlowRemovedReason value)
      Set the property corresponding to FlowRemoved.getReason() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTableId

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

    • setVersion

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