com.adventnet.snmp.mibs.mibparser
Class SyntaxTextualConvention

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

All Implemented Interfaces:

BaseSyntax, MIBConstants

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

Field Summary

CommentClass	commentObj For processing Comments
java.lang.String	description The TC description
java.lang.String	displayHint the display-hint for this TC
java.lang.String	identity The String identifying this OID
(package private) RangeList	rangeObject
java.lang.String	reference The TC Reference
int	status The status for this
BaseSyntax	syntax the base syntax for this textual convention

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

SyntaxTextualConvention()
Just so as to create a TC internally

Method Summary

SyntaxTextualConvention	copy()
java.lang.String	getDescription() this tc's decription
java.lang.String	getDisplayHint() Returns the display-hint corresponding to this TC.
java.lang.String	getName() Returns this TC's name
BaseSyntax	getParentSyntax() returns the syntax for this tc which might be a tc in turn.
RangeList	getRange() Returns the range object corresponding to this instance
java.lang.String	getReference() the reference clause for this tc
int	getStatus() Return the int value corresponding to this TC's status
BaseSyntax	getSyntax() returns the base syntax for this TC
int	getType()
void	merge(SyntaxTextualConvention stc)
void	setDescription(java.lang.String descr) the description for this tc
void	setDisplayHint(java.lang.String hint) The display-hint corresponding to this TC.
void	setName(java.lang.String name) Sets this TC's's name identifier
void	setRange(RangeList list) Set the range delimiting object for this instance
void	setReference(java.lang.String refr) the reference clause for this tc
void	setStatus(int tcStatus) Sets the status for the TC.
void	setSyntax(BaseSyntax syn) Sets this object's syntax to the BaseSyntax
void	writeElements(java.io.DataOutputStream outp, java.io.DataOutputStream descOutp)
static void	writeType(BaseSyntax syn, java.io.DataOutputStream outp, java.io.DataOutputStream descOutp)

Methods inherited from class java.lang.Object

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

Field Detail

identity

public java.lang.String identity

The String identifying this OID

displayHint

public java.lang.String displayHint

the display-hint for this TC

status

public int status

The status for this

description

public java.lang.String description

The TC description

reference

public java.lang.String reference

The TC Reference

commentObj

public CommentClass commentObj

For processing Comments

syntax

public BaseSyntax syntax

the base syntax for this textual convention

rangeObject

RangeList rangeObject

Constructor Detail

SyntaxTextualConvention

SyntaxTextualConvention()

Just so as to create a TC internally

Method Detail

setName

public void setName(java.lang.String name)

Sets this TC's's name identifier

getName

public java.lang.String getName()

Returns this TC's name

Specified by:

getName in interface BaseSyntax

setSyntax

public void setSyntax(BaseSyntax syn)

Sets this object's syntax to the BaseSyntax

getSyntax

public BaseSyntax getSyntax()

returns the base syntax for this TC

Specified by:

getSyntax in interface BaseSyntax

getParentSyntax

public BaseSyntax getParentSyntax()

returns the syntax for this tc which might be a tc in turn. the getSyntax method will return the most basic syntax

setDisplayHint

public void setDisplayHint(java.lang.String hint)

The display-hint corresponding to this TC.

getDisplayHint

public java.lang.String getDisplayHint()

Returns the display-hint corresponding to this TC. Could be null

setStatus

public void setStatus(int tcStatus)

Sets the status for the TC. The constants are defined in BaseSyntax

getStatus

public int getStatus()

Return the int value corresponding to this TC's status

See Also:

setStatus(int)

setDescription

public void setDescription(java.lang.String descr)

the description for this tc

getDescription

public java.lang.String getDescription()

this tc's decription

setReference

public void setReference(java.lang.String refr)

the reference clause for this tc

getReference

public java.lang.String getReference()

the reference clause for this tc

copy

public SyntaxTextualConvention copy()

setRange

public void setRange(RangeList list)

Set the range delimiting object for this instance

Specified by:

setRange in interface BaseSyntax

getRange

public RangeList getRange()

Returns the range object corresponding to this instance

Specified by:

getRange in interface BaseSyntax

merge

public void merge(SyntaxTextualConvention stc)

getType

public int getType()

Specified by:

getType in interface BaseSyntax

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

writeType

public static void writeType(BaseSyntax syn,
                             java.io.DataOutputStream outp,
                             java.io.DataOutputStream descOutp)
                      throws java.io.IOException

Throws:

java.io.IOException