Interface TableFeatures

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<TableFeatures>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<TableFeatures>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<TableFeaturesKey>

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

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

     list table-features {
       key table-id;
       leaf table-id {
         type uint8;
       }
       leaf name {
         type string;
       }
       leaf metadata-match {
         type uint64;
       }
       leaf metadata-write {
         type uint64;
       }
       leaf max-entries {
         type uint32;
       }
       leaf config {
         type table-config;
       }
       container table-properties {
         list table-feature-properties {
           key order;
           uses action:ordered;
           uses table-feature-prop-type;
         }
       }
     }
     

    To create instances of this class use TableFeaturesBuilder.

    See Also:
    TableFeaturesBuilder, TableFeaturesKey
    • 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<TableFeatures> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • bindingHashCode

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

        org.opendaylight.yangtools.yang.common.Uint8 getTableId()
        Return tableId, or null if it is not present.
        Returns:
        Uint8 tableId, or null if it is not present.
      • requireTableId

        default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireTableId()
        Return tableId, guaranteed to be non-null.
        Returns:
        Uint8 tableId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if tableId is not present
      • getName

        String getName()
        Return name, or null if it is not present.
             
                 Name of the table
             
         
        Returns:
        String name, or null if it is not present.
      • requireName

        default @NonNull String requireName()
        Return name, guaranteed to be non-null.
             
                 Name of the table
             
         
        Returns:
        String name, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if name is not present
      • getMetadataMatch

        org.opendaylight.yangtools.yang.common.Uint64 getMetadataMatch()
        Return metadataMatch, or null if it is not present.
             
                 Bits of metadata table can match
             
         
        Returns:
        Uint64 metadataMatch, or null if it is not present.
      • requireMetadataMatch

        default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireMetadataMatch()
        Return metadataMatch, guaranteed to be non-null.
             
                 Bits of metadata table can match
             
         
        Returns:
        Uint64 metadataMatch, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if metadataMatch is not present
      • getMetadataWrite

        org.opendaylight.yangtools.yang.common.Uint64 getMetadataWrite()
        Return metadataWrite, or null if it is not present.
             
                 Bits of metadata table can write
             
         
        Returns:
        Uint64 metadataWrite, or null if it is not present.
      • requireMetadataWrite

        default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireMetadataWrite()
        Return metadataWrite, guaranteed to be non-null.
             
                 Bits of metadata table can write
             
         
        Returns:
        Uint64 metadataWrite, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if metadataWrite is not present
      • getMaxEntries

        org.opendaylight.yangtools.yang.common.Uint32 getMaxEntries()
        Return maxEntries, or null if it is not present.
             
                 Max number of entries supported
             
         
        Returns:
        Uint32 maxEntries, or null if it is not present.
      • requireMaxEntries

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireMaxEntries()
        Return maxEntries, guaranteed to be non-null.
             
                 Max number of entries supported
             
         
        Returns:
        Uint32 maxEntries, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if maxEntries is not present
      • getConfig

        TableConfig getConfig()
        Return config, or null if it is not present.
             
                 Bitmap of OFPTC_ values
             
         
        Returns:
        TableConfig config, or null if it is not present.
      • requireConfig

        default @NonNull TableConfig requireConfig()
        Return config, guaranteed to be non-null.
             
                 Bitmap of OFPTC_ values
             
         
        Returns:
        TableConfig config, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if config is not present
      • getTableProperties

        TableProperties getTableProperties()
        Return tableProperties, or null if it is not present.
        Returns:
        TableProperties tableProperties, or null if it is not present.