diagapplet.CodeGen

Interface DiagNMLMsgDictInterface

All Superinterfaces:

NMLMessageDictionary

All Known Implementing Classes:

DiagNMLMsgDict

public interface DiagNMLMsgDictInterface
extends NMLMessageDictionary

NMLMessageDictionaries allow the marshalling and unmarshalling of NML messages. They are generally created using the CodeGenerator and therefore have type information built in at compile-time. The Diag version must discover the type information at runtime. This interface allows the CodeGen code to interact with a DiagNMLMsgDict without an explicit dependancy. Many of the functions added relate to logging error messages. The need to eliminate circular dependancies came from seperately compiling each java file in a Makefile with a variety of compilers. It is likely no longer necessary to eliminate the circular dependancies.

See Also:

NMLFormatConvertErrCallbackInterface

Method Summary

Modifier and Type	Method and Description
void	bytesNotUsed(int bytes_in_input_stream, java.lang.String bufName, boolean warn_given) Used to log a warning message if the dictionary results do not match the expected input.
int	get_failed_count() Returns the number of errors that have occured related to this dictionary.
void	miscError() Log Information about this dictionary when generic NML error occurs.
void	miscError(java.lang.Exception e) Log Information about this dictionary when NML error occurs with a related Exception called by NMLFormatConvertErrCallbackInterface
void	SetModuleInfoObject(ModuleInfoInterface mi) Used to set a ModuleInfo object, needed for this to function.
void	tokensNotUsed(int num_tokens, java.lang.String input_string, boolean warn_given) Used to log a warning message if the dictionary results do not match the expected input.

Methods inherited from interface rcs.nml.NMLMessageDictionary

formatMsg, getEstimatedSize, getMaxEstimatedSize

Method Detail

SetModuleInfoObject

void SetModuleInfoObject(ModuleInfoInterface mi)

Used to set a ModuleInfo object, needed for this to function. The non type safe use of an object parameter

Parameters:

mi - new module info object

get_failed_count

int get_failed_count()

Returns the number of errors that have occured related to this dictionary. incremented automatically.

Returns:

failed_count.

tokensNotUsed

void tokensNotUsed(int num_tokens,
                   java.lang.String input_string,
                   boolean warn_given)

Used to log a warning message if the dictionary results do not match the expected input.

Parameters:

num_tokens - -- number tokens in input_string

input_string - -- comma delimited string to be parsed

warn_given - -- if already warned do not warn again.

bytesNotUsed

void bytesNotUsed(int bytes_in_input_stream,
                  java.lang.String bufName,
                  boolean warn_given)

Used to log a warning message if the dictionary results do not match the expected input.

Parameters:

bytes_in_input_stream - -- number of bytes read

bufName - -- NML buffer name

warn_given - -- if already warned do not warn again.

miscError

void miscError()

Log Information about this dictionary when generic NML error occurs. called by NMLFormatConvertErrCallbackInterface

miscError

void miscError(java.lang.Exception e)

Log Information about this dictionary when NML error occurs with a related Exception called by NMLFormatConvertErrCallbackInterface

Parameters:

e - exception to log