net.percederberg.mibble.snmp
Class SnmpTextualConvention

java.lang.Object
  extended bynet.percederberg.mibble.snmp.SnmpTextualConvention
All Implemented Interfaces:
MibContext, MibType

public class SnmpTextualConvention
extends java.lang.Object
implements MibType, MibContext

An SNMP textual convention.

Since:
2.0

Constructor Summary
SnmpTextualConvention(java.lang.String displayHint, SnmpStatus status, java.lang.String description, java.lang.String reference, MibType syntax)
          Creates a new SNMP textual convention.
 
Method Summary
 java.lang.String getDescription()
          Returns the type description.
 java.lang.String getDisplayHint()
          Returns the display hint.
 java.lang.String getReference()
          Returns the type reference.
 SnmpStatus getStatus()
          Returns the type status.
 MibSymbol getSymbol(java.lang.String name)
          Returns a named MIB symbol.
 MibType getSyntax()
          Returns the type syntax.
 MibType initialize(MibLoaderLog log)
          Initializes the MIB type.
 boolean isCompatible(MibValue value)
          Checks if the specified value is compatible with this type.
 java.lang.String toString()
          Returns a string representation of this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SnmpTextualConvention

public SnmpTextualConvention(java.lang.String displayHint,
                             SnmpStatus status,
                             java.lang.String description,
                             java.lang.String reference,
                             MibType syntax)
Creates a new SNMP textual convention.

Parameters:
displayHint - the display hint, or null
status - the type status
description - the type description
reference - the type reference, or null
syntax - the type syntax
Method Detail

initialize

public MibType initialize(MibLoaderLog log)
                   throws MibException
Initializes the MIB type. This will remove all levels of indirection present, such as references to other types, and returns the basic type. No type information is lost by this operation. This method may modify this object as a side-effect, and will be called by the MIB loader.

Specified by:
initialize in interface MibType
Parameters:
log - the MIB loader log
Returns:
the basic MIB type
Throws:
MibException - if an error was encountered during the initialization

isCompatible

public boolean isCompatible(MibValue value)
Checks if the specified value is compatible with this type. No value is compatible with this type, so this method always returns false.

Specified by:
isCompatible in interface MibType
Parameters:
value - the value to check
Returns:
true if the value is compatible, or false otherwise

getDisplayHint

public java.lang.String getDisplayHint()
Returns the display hint.

Returns:
the display hint, or null if no display hint has been set

getStatus

public SnmpStatus getStatus()
Returns the type status.

Returns:
the type status

getDescription

public java.lang.String getDescription()
Returns the type description.

Returns:
the type description

getReference

public java.lang.String getReference()
Returns the type reference.

Returns:
the type reference, or null if no reference has been set

getSyntax

public MibType getSyntax()
Returns the type syntax.

Returns:
the type syntax

getSymbol

public MibSymbol getSymbol(java.lang.String name)
Returns a named MIB symbol. This method checks the syntax type for a MibContext implementation.

Specified by:
getSymbol in interface MibContext
Parameters:
name - the symbol name
Returns:
the MIB symbol, or null if not found

toString

public java.lang.String toString()
Returns a string representation of this object.

Returns:
a string representation of this object