Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026

Interface FlowMessage

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<FlowMessage>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<OpendaylightFlowTypesData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, Flow, GenericFlowAttributes, OfHeader
@Generated("mdsal-binding-generator") public interface FlowMessage extends org.opendaylight.yangtools.yang.binding.ChildOf<OpendaylightFlowTypesData>, org.opendaylight.yangtools.yang.binding.Augmentable<FlowMessage>, Flow, OfHeader

This class represents the following YANG schema fragment defined in module opendaylight-flow-types 

 container flow-message {
   uses flow;
   uses ofproto:ofHeader;
   leaf command {
     type oft:flow-mod-command;
   }
 }

To create instances of this class use FlowMessageBuilder.

See Also:

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      default Class<FlowMessage> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      Specified by:
      implementedInterface in interface Flow
      Specified by:
      implementedInterface in interface GenericFlowAttributes
      Specified by:
      implementedInterface in interface OfHeader

    • bindingHashCode

      static int bindingHashCode(@NonNull FlowMessage obj)
      Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
      Parameters:
      obj - Object for which to generate hashCode() result.
      Returns:
      Hash code value of data modeled by this interface.
      Throws:
      NullPointerException - if obj is null

    • bindingEquals

      static boolean bindingEquals(@NonNull FlowMessage thisObj, Object obj)
      Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
      Parameters:
      thisObj - Object acting as the receiver of equals invocation
      obj - Object acting as argument to equals invocation
      Returns:
      True if thisObj and obj are considered equal
      Throws:
      NullPointerException - if thisObj is null

    • bindingToString

      static String bindingToString(@NonNull FlowMessage obj)
      Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
      Parameters:
      obj - Object for which to generate toString() result.
      Returns:
      String value of data modeled by this interface.
      Throws:
      NullPointerException - if obj is null

    • getCommand

      FlowModCommand getCommand()
      Return command, or null if it is not present.
      Returns:
      FlowModCommand command, or null if it is not present.

    • requireCommand

      default @NonNull FlowModCommand requireCommand()
      Return command, guaranteed to be non-null.
      Returns:
      FlowModCommand command, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if command is not present