com.objsys.asn1j.runtime

Class Asn1PerTraceHandler

java.lang.Object

com.objsys.asn1j.runtime.Asn1PerTraceHandler

Direct Known Subclasses:

Asn1PerDecodeTraceHandler, Asn1PerEncodeTraceHandler, Asn1PerOutputStreamTraceHandler

public abstract class Asn1PerTraceHandler
extends java.lang.Object

This is the abstract base class for the encode and decode trace handler derived classes. (This was originally for PER but is now used more generally.)

Field Summary

Fields

Modifier and Type	Field and Description
protected Asn1PerBitFieldList	mBitFieldList

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Asn1PerTraceHandler(Asn1BitMessageBuffer messageBuffer) This constructor initializes internal trace handler member variables.

Method Summary

Modifier and Type	Method and Description
void	addElemName(java.lang.String name, int arrayx) This method adds an element name to the current fully qualified name.
abstract void	enable() This method is used to turn bit tracing on or off.
Asn1PerBitFieldList	getBitFieldList() This method returns a reference to the bit field list
boolean	isEnabled() Check whether bit tracing is on or off.
void	newBitField(java.lang.String name, int bitCount) This method creates a new bit field and appends it to the bit field list.
abstract void	print(java.io.PrintStream out, java.lang.String varName) This method prints the trace to the given output stream in a default format.
void	removeLastElemName() This method removes the last element name int the current fully qualified name string.
void	replaceLastFieldWithDetail(Asn1PerTraceHandler details) Replaces the last bit field in this bit trace handler with the fields from the given trace handler, which are assumed to be a breakdown of the last field.
abstract void	reset() This method resets the trace bit field list.
void	setBitCount() This method sets the bit count within the current bit field to the difference between the current but offset and the starting bit offset currently stored in the field object.
void	setBitOffset() This method sets the bit offset within the current bit field to the current offset within the PER message buffer.
void	updateBitField() This method updates the length of the previously added bit field based on the current buffer position.

Methods inherited from class java.lang.Object

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

Field Detail

mBitFieldList

protected Asn1PerBitFieldList mBitFieldList

Constructor Detail

Asn1PerTraceHandler

protected Asn1PerTraceHandler(Asn1BitMessageBuffer messageBuffer)

This constructor initializes internal trace handler member variables.

Parameters:

messageBuffer - PER message buffer object reference

Method Detail

addElemName

public void addElemName(java.lang.String name,
                        int arrayx)

This method adds an element name to the current fully qualified name. The fully qualified name is a string of name components separated by dots (ex. a.b.c).

Parameters:

name - Name component to append to string

arrayx - Array index if named item is an element in an array (set to -1 otherwise)

enable

public abstract void enable()

This method is used to turn bit tracing on or off. POST: mBitFieldList != null

isEnabled

public boolean isEnabled()

Check whether bit tracing is on or off.

getBitFieldList

public Asn1PerBitFieldList getBitFieldList()

This method returns a reference to the bit field list

newBitField

public void newBitField(java.lang.String name,
                        int bitCount)

This method creates a new bit field and appends it to the bit field list. The field begins at the current location and has the given length. If the length is unknown, use zero and then make a subsequent call to updateBitField to update the length.

Parameters:

name - Name suffix to append to the current fully qualified name.

bitCount - Number of bits in the bit field.

updateBitField

public final void updateBitField()

This method updates the length of the previously added bit field based on the current buffer position. This can be invoked just after encoding a field to update that field's length. You must have called newBitField just prior to encoding the field.

print

public abstract void print(java.io.PrintStream out,
                           java.lang.String varName)

This method prints the trace to the given output stream in a default format.

Parameters:

out - Print stream to which output is to be written.

varName - Name of the object variable being printed.

removeLastElemName

public void removeLastElemName()

This method removes the last element name int the current fully qualified name string. For example, if the current string is 'a.b.c', it will be 'a.b' after calling this method.

replaceLastFieldWithDetail

public void replaceLastFieldWithDetail(Asn1PerTraceHandler details)

Replaces the last bit field in this bit trace handler with the fields from the given trace handler, which are assumed to be a breakdown of the last field.

Parameters:

details - If the current trace handler (this) has tracing enabled, then details must also have tracing enabled.

reset

public abstract void reset()

This method resets the trace bit field list.

setBitCount

public void setBitCount()

This method sets the bit count within the current bit field to the difference between the current but offset and the starting bit offset currently stored in the field object.

setBitOffset

public void setBitOffset()

This method sets the bit offset within the current bit field to the current offset within the PER message buffer.