Package org.netxms.client.snmp
Class SnmpObjectId
java.lang.Object
org.netxms.client.snmp.SnmpObjectId
This class represents SNMP Object Id (OID)
-
Constructor Summary
ConstructorDescriptionCreate empty OIDSnmpObjectId
(long[] value) Create OID from array of OID elementsSnmpObjectId
(SnmpObjectId parent, long id) Create child OID - add given value at the end of parent OID. -
Method Summary
Modifier and TypeMethodDescriptionint
compareTo
(SnmpObjectId oid) Compare two object identifiers.boolean
long
getIdFromPos
(int pos) Get part of object ID from given position.int
Get object identifier length.int
hashCode()
static SnmpObjectId
Parse string argument as SNMP OID.void
setNXCPVariable
(NXCPMessage msg, long varId) Set NXCP variable to OID's valueboolean
startsWith
(SnmpObjectId oid) Check if this object id starts with given object id.toString()
-
Constructor Details
-
SnmpObjectId
public SnmpObjectId()Create empty OID -
SnmpObjectId
public SnmpObjectId(long[] value) Create OID from array of OID elements- Parameters:
value
- OID elements
-
SnmpObjectId
Create child OID - add given value at the end of parent OID.- Parameters:
parent
- parent OIDid
- id
-
-
Method Details
-
parseSnmpObjectId
Parse string argument as SNMP OID. Expected to be ion format .n.n.n.n.n- Parameters:
s
- string to parse- Returns:
- SNMP OID object
- Throws:
SnmpObjectIdFormatException
- when string passed is not a valid SNMP OID
-
getLength
public int getLength()Get object identifier length.- Returns:
- OID length
-
setNXCPVariable
Set NXCP variable to OID's value- Parameters:
msg
- NXCP messagevarId
- Variable ID
-
startsWith
Check if this object id starts with given object id.- Parameters:
oid
- Object id to check- Returns:
- true if this object id starts with given object id
-
compareTo
Compare two object identifiers. The return value is -1 if this object identifier is less than given object identifier, 0 if they are equal, and 1 if this object identifier is greater then given object identifier.- Parameters:
oid
- object identifier to compare with- Returns:
- -1, 0, or 1 (see above for details)
-
getIdFromPos
public long getIdFromPos(int pos) Get part of object ID from given position.- Parameters:
pos
- position- Returns:
- part of object id from given position or -1 if position is invalid
-
equals
-
hashCode
public int hashCode() -
toString
-