com.adventnet.snmp.mibs.mibparser
Class SyntaxOID

java.lang.Object
  com.adventnet.snmp.mibs.mibparser.SyntaxOID

All Implemented Interfaces:

BaseSyntax, MIBConstants

Direct Known Subclasses:

SyntaxAgentCapabilities, SyntaxModuleCompliance, SyntaxModuleIdentity, SyntaxNotification, SyntaxNotificationGroup, SyntaxObjectGroup, SyntaxObjectIdentity, SyntaxObjectType

public class SyntaxOID
extends java.lang.Object
implements BaseSyntax, MIBConstants

Field Summary

java.util.Vector	childOIDList Vector containing all the child SyntaxOIDs
(package private) java.util.Vector	childoids Oids of child nodes as Integer objects
CommentClass	commentObj For processing Comments
(package private) java.lang.String	identity The String identifying this OID
(package private) int[]	oid_tree The complete oid tree
(package private) SyntaxOID	parentOIDSyntax A reference to the parent OID .
(package private) BaseSyntax	syntax A syntax object attached to this OID.
(package private) int	value The int value of this oid.

Fields inherited from interface com.adventnet.snmp.mibs.mibparser.BaseSyntax

NullString

Fields inherited from interface com.adventnet.snmp.mibs.mibparser.MIBConstants

ACCESS_ACCESSIBLE_FOR_NOTIFY, ACCESS_NOT_ACCESSIBLE, ACCESS_NOT_IMPLEMENTED, ACCESS_READ_CREATE, ACCESS_READ_ONLY, ACCESS_READ_WRITE, ACCESS_WRITE_ONLY, accessStr, AGENT_CAPABILITIES, alphaStr, BITSTRING, COUNTER, COUNTER32, COUNTER64, GAUGE, GAUGE32, INTEGER, INTEGER32, IPADDRESS, macroStr, MODULE_COMPLIANCE, MODULE_IDENTITY, NETWORKADDRESS, NOTIFICATION_GROUP, NOTIFICATION_TYPE, NULL, numericStr, OBJECT_GROUP, OBJECT_IDENTIFIER, OBJECT_IDENTITY, OBJECT_TYPE, OCTETSTRING, OPAQUE, SEQUENCE, STATUS_CURRENT, STATUS_DEPRECATED, STATUS_MANDATORY, STATUS_OBSOLETE, STATUS_OPTIONAL, statusStr, TEXTUAL_CONVENTION, TIMETICKS, TRAP_TYPE, UNSIGNED32

Constructor Summary

SyntaxOID()
Just so as to create a syntax with root objects internally

Method Summary

SyntaxOID	addChild(int oid) creates and adds SyntaxOID to parent with that oid value addition
void	assign(SyntaxOID oid)
(package private) SyntaxOID[]	detectRoot()
static SyntaxOID	getInstance(SyntaxOID parent, java.lang.String name, int oid_value) Returns a new SyntaxOID with the parameters specified
java.lang.String	getName() Returns this OID's name
int[]	getOIDValue()
RangeList	getRange()
BaseSyntax	getSyntax() Returns a reference to the syntax of this OID.
int	getType()
int	getValue() Returns this OID's value identifier
boolean	isChild(SyntaxOID oid)
void	merge(SyntaxOID oid)
SyntaxOID	removeInstance() Removes this instance and all children from oidList.
void	setName(java.lang.String name) Sets this OID's name identifier
void	setRange(RangeList list)
void	setSyntax(BaseSyntax oid_syntax) Attach a syntax object to this OID
void	setValue(int identifier) Sets this OID's value identifier {dod(3) 4} will be 4
(package private) int	size()
java.lang.String	toBigString()
java.lang.String	toString()
void	writeElements(java.io.DataOutputStream outp, java.io.DataOutputStream descOutp)
(package private) void	writeSyntaxRelated(java.io.DataOutputStream outp, java.io.DataOutputStream descOutp)

Methods inherited from class java.lang.Object

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

Field Detail

parentOIDSyntax

SyntaxOID parentOIDSyntax

A reference to the parent OID . Null for root(usually iso etc. except in case of phantom OIDs

childOIDList

public java.util.Vector childOIDList

Vector containing all the child SyntaxOIDs

oid_tree

int[] oid_tree

The complete oid tree

childoids

java.util.Vector childoids

Oids of child nodes as Integer objects

value

int value

The int value of this oid. could be negative(need to convert to long before using) -1 if phantom node.

identity

java.lang.String identity

The String identifying this OID

syntax

BaseSyntax syntax

A syntax object attached to this OID. Could be a ranged Integer type etc.

commentObj

public CommentClass commentObj

For processing Comments

Constructor Detail

SyntaxOID

SyntaxOID()

Just so as to create a syntax with root objects internally

Method Detail

getInstance

public static SyntaxOID getInstance(SyntaxOID parent,
                                    java.lang.String name,
                                    int oid_value)

Returns a new SyntaxOID with the parameters specified

setName

public void setName(java.lang.String name)

Sets this OID's name identifier

getName

public java.lang.String getName()

Returns this OID's name

Specified by:

getName in interface BaseSyntax

setValue

public void setValue(int identifier)

Sets this OID's value identifier {dod(3) 4} will be 4

getValue

public int getValue()

Returns this OID's value identifier

removeInstance

public SyntaxOID removeInstance()

Removes this instance and all children from oidList. Helps in unloading

setSyntax

public void setSyntax(BaseSyntax oid_syntax)

Attach a syntax object to this OID

getSyntax

public BaseSyntax getSyntax()

Returns a reference to the syntax of this OID.

Specified by:

getSyntax in interface BaseSyntax

getType

public int getType()

Specified by:

getType in interface BaseSyntax

addChild

public SyntaxOID addChild(int oid)

creates and adds SyntaxOID to parent with that oid value addition

isChild

public boolean isChild(SyntaxOID oid)

getOIDValue

public int[] getOIDValue()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toBigString

public java.lang.String toBigString()

merge

public void merge(SyntaxOID oid)

setRange

public void setRange(RangeList list)

Specified by:

setRange in interface BaseSyntax

detectRoot

SyntaxOID[] detectRoot()

size

int size()

writeElements

public void writeElements(java.io.DataOutputStream outp,
                          java.io.DataOutputStream descOutp)
                   throws java.io.IOException

Specified by:

writeElements in interface BaseSyntax

Throws:

java.io.IOException

getRange

public RangeList getRange()

Specified by:

getRange in interface BaseSyntax

assign

public void assign(SyntaxOID oid)

writeSyntaxRelated

void writeSyntaxRelated(java.io.DataOutputStream outp,
                        java.io.DataOutputStream descOutp)
                  throws java.io.IOException

Throws:

java.io.IOException