net.rim.device.api.util
Interface TLEFieldController


public interface TLEFieldController

Defines methods to read and write type-length encoded (TLE) fields.


Method Summary
 void dumpField(int type, DataBuffer db)
          Retrieves field's data into buffer.
 boolean processField(int type, int length, DataBuffer db)
          Processes the data in a field.
 



Method Detail

processField

boolean processField(int type,
                     int length,
                     DataBuffer db)
                     throws IllegalArgumentException,
                            EOFException
Processes the data in a field.

Parameters:
type - Type byte of the field.
length - Length of the field.
db - DataBuffer containing the field's data; read position in the buffer must be at the start of the data for the field.
Returns:
True if the buffer's data is consumed; otherwise, false.
Throws:
IllegalArgumentException - If data buffer and type don't match.
EOFException - If end of buffer is reached before length read.

dumpField

void dumpField(int type,
               DataBuffer db)
Retrieves field's data into buffer.

Variable-length fields (such as one containing sub-fields) can implement this method to dump their entire contents into the provided data buffer.

Parameters:
type - Type of field from which to extract the data.
db - Data buffer to contain the data extracted from the field; upon return, write position in the buffer must be at the end of the field's data.





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.