Interface TextualConvention<V extends org.snmp4j.smi.Variable>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      MOColumn<V> createColumn​(int columnID, int syntax, MOAccess access, V defaultValue, boolean mutableInService)
      Creates a MOColumn instance of this TC specified by the column ID, access, default value, and mutable flag.
      V createInitialValue​()
      Creates an initial value for an object instance of this textual convention.
      MOScalar<V> createScalar​(org.snmp4j.smi.OID oid, MOAccess access, V value)
      Creates a MOScalar instance of this TC specified by OID, access, and optional value.
      String getModuleName​()
      Returns the MIB module name that defined this textual convention.
      String getName​()
      Returns the name of the textual convention as defined in the MIB module.
    • Method Detail

      • getModuleName

        String getModuleName​()
        Returns the MIB module name that defined this textual convention.
        Returns:
        an unique module name
      • getName

        String getName​()
        Returns the name of the textual convention as defined in the MIB module.
        Returns:
        the unique name (within the MIB module) of the TC.
      • createScalar

        MOScalar<V> createScalar​(org.snmp4j.smi.OID oid,
                                 MOAccess access,
                                 V value)
        Creates a MOScalar instance of this TC specified by OID, access, and optional value.
        Parameters:
        oid - the OID of the scalar isntance.
        access - the access definition.
        value - the Variable instance containing the value of the scalar. If value is null, the TC should create an initial value with createInitialValue().
        Returns:
        a MOScalar instance.
      • createColumn

        MOColumn<V> createColumn​(int columnID,
                                 int syntax,
                                 MOAccess access,
                                 V defaultValue,
                                 boolean mutableInService)
        Creates a MOColumn instance of this TC specified by the column ID, access, default value, and mutable flag.
        Parameters:
        columnID - the column id as defined in the MIB module (typically starting at one).
        syntax - the SMI syntax supported by the column.
        access - the access definition.
        defaultValue - the default value or null if there is no DEFVAL clause for this column.
        mutableInService - true if this column may be modified while row is in service.
        Returns:
        the MOColumn created.
      • createInitialValue

        V createInitialValue​()
        Creates an initial value for an object instance of this textual convention.
        Returns:
        a Variable instance with a valid value (according to this TC).
        Since:
        1.3