Package org.snmp4j.smi

Interface SubIndexInfo

All Known Implementing Classes:
SubIndexInfoImpl
public interface SubIndexInfo
The SubIndexInfo interface represents the meta information of a SMI INDEX clause element (= sub-index) which are relevant for converting an OID index value to an INDEX object and vice versa.
Since:
2.5.0
Author:
Frank Fock

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getMaxLength()
    Gets the maximum length in bytes of the sub-index.
    int
    getMinLength()
    Gets the minimum length in bytes of the sub-index.
    int
    getSnmpSyntax()
    Gets the SNMP syntax value of the sub-index' base syntax.
    boolean
    hasImpliedLength()
    Checks if the sub-index represented by this index info has an implied length or not.

  • Method Details

    • hasImpliedLength

      boolean hasImpliedLength()
      Checks if the sub-index represented by this index info has an implied length or not.
      Returns:
      true if the length of this variable length sub-index is implied (i.e., the sub-index is the last in the index).

    • getMinLength

      int getMinLength()
      Gets the minimum length in bytes of the sub-index. If min and max length are equal, then this sub-index is a fixed length length sub-index.
      Returns:
      the minimum length of the (sub-index) in bytes.

    • getMaxLength

      int getMaxLength()
      Gets the maximum length in bytes of the sub-index. If min and max length are equal, then this sub-index is a fixed length length sub-index.
      Returns:
      the maximum length of the (sub-index) in bytes.

    • getSnmpSyntax

      int getSnmpSyntax()
      Gets the SNMP syntax value of the sub-index' base syntax.
      Returns:
      the SNMP4J (BER) syntax identifier.