Interface Flow

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Flow>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Table>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, Flow, GenericFlowAttributes, org.opendaylight.yangtools.yang.binding.Identifiable<FlowKey>

    @Generated("mdsal-binding-generator")
    public interface Flow
    extends org.opendaylight.yangtools.yang.binding.ChildOf<Table>, org.opendaylight.yangtools.yang.binding.Augmentable<Flow>, Flow, org.opendaylight.yangtools.yang.binding.Identifiable<FlowKey>

    This class represents the following YANG schema fragment defined in module flow-node-inventory

     list flow {
       key id;
       leaf id {
         type flow-id;
       }
       uses flow:flow;
     }
     

    To create instances of this class use FlowBuilder.

    See Also:
    FlowBuilder, FlowKey
    • Field Detail

      • QNAME

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

      • implementedInterface

        default Class<Flow> implementedInterface()
        Specified by:
        implementedInterface in interface 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
      • bindingHashCode

        static int bindingHashCode​(@NonNull Flow 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 Flow 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 Flow 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
      • key

        FlowKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<FlowKey>
      • getId

        FlowId getId()
        Return id, or null if it is not present.
        Returns:
        FlowId id, or null if it is not present.
      • requireId

        default @NonNull FlowId requireId()
        Return id, guaranteed to be non-null.
        Returns:
        FlowId id, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if id is not present