org.snmp4j.agent.mo
Class MOTableSubIndex

java.lang.Object
  org.snmp4j.agent.mo.MOTableSubIndex

public class MOTableSubIndex
extends java.lang.Object

The MOTableSubIndex class represents a sub-index definition.

Version:

1.0

Author:

Frank Fock

Constructor Summary

MOTableSubIndex(int smiSyntax)
Creates a sub-index definition based on a SMI syntax.

MOTableSubIndex(int smiSyntax, int minLength, int maxLength)
Creates a sub-index definition based on a SMI syntax, minimum, and maximum sub-index length.

MOTableSubIndex(org.snmp4j.smi.OID oid, int smiSyntax)
Creates a sub-index definition based on a SMI syntax and the OID of the sub-index OBJECT-TYPE definition.

MOTableSubIndex(org.snmp4j.smi.OID oid, int smiSyntax, int minLength, int maxLength)
Creates a sub-index definition based on a SMI syntax, minimum, and maximum sub-index length as well as the OID of the sub-index OBJECT-TYPE.

Method Summary

int	getMaxLength() Returns the maximum sub-index length.
int	getMinLength() Returns the minimum sub-index length.
org.snmp4j.smi.OID	getOid() Returns the optional OID of the sub-index object definition.
int	getSmiSyntax() Gets the SMI syntax of the sub-index.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MOTableSubIndex

public MOTableSubIndex(int smiSyntax)

Creates a sub-index definition based on a SMI syntax.

Parameters:

smiSyntax - a SMI syntax ID as defined by SMIConstants.

MOTableSubIndex

public MOTableSubIndex(org.snmp4j.smi.OID oid,
                       int smiSyntax)

Creates a sub-index definition based on a SMI syntax and the OID of the sub-index OBJECT-TYPE definition.

Parameters:

oid - the OID of the sub-index definition's OBJECT-TYPE.

smiSyntax - a SMI syntax ID as defined by SMIConstants.

MOTableSubIndex

public MOTableSubIndex(int smiSyntax,
                       int minLength,
                       int maxLength)

Creates a sub-index definition based on a SMI syntax, minimum, and maximum sub-index length.

Parameters:

smiSyntax - a SMI syntax ID as defined by SMIConstants.

minLength - the minimum length of the sub-index (must not be greater than maxLength).

maxLength - the maximum length of the sub-index (must not be less than minLength).

MOTableSubIndex

public MOTableSubIndex(org.snmp4j.smi.OID oid,
                       int smiSyntax,
                       int minLength,
                       int maxLength)

Creates a sub-index definition based on a SMI syntax, minimum, and maximum sub-index length as well as the OID of the sub-index OBJECT-TYPE.

Parameters:

oid - the OID of the sub-index definition's OBJECT-TYPE.

smiSyntax - a SMI syntax ID as defined by SMIConstants.

minLength - the minimum length of the sub-index (must not be greater than maxLength).

maxLength - the maximum length of the sub-index (must not be less than minLength).

Method Detail

getSmiSyntax

public int getSmiSyntax()

Gets the SMI syntax of the sub-index.

Returns:

a SMI syntax as defined by SMIConstants.

getMinLength

public int getMinLength()

Returns the minimum sub-index length.

Returns:

the minimum length.

getMaxLength

public int getMaxLength()

Returns the maximum sub-index length.

Returns:

the maximum length.

getOid

public org.snmp4j.smi.OID getOid()

Returns the optional OID of the sub-index object definition.

Returns:

the OID of the sub-index object or null if that has not been specified on sub-index creation.