org.shredzone.pdbconverter.pdb.converter

Interface Converter<T extends Record,U extends AppInfo>

All Known Implementing Classes:

AddressConverter, MemoConverter, NotepadConverter, RawConverter, ScheduleConverter, TodoConverter

public interface Converter<T extends Record,U extends AppInfo>

Converts a PDB record into an Record object.

Author:

Richard "Shred" Körber

Method Summary

Modifier and Type	Method and Description
T	convert(PdbFile reader, int record, int size, int attribute, PdbDatabase<T,U> database) Converts raw record data to a Record object.
U	convertAppInfo(PdbFile reader, int size, PdbDatabase<T,U> database) Converts raw application info data to an AppInfo.
boolean	isAcceptable(PdbDatabase<T,U> database) Checks if this record converter is able to convert records for the PdbDatabase.

Method Detail

isAcceptable

boolean isAcceptable(PdbDatabase<T,U> database)

Checks if this record converter is able to convert records for the PdbDatabase.

Parameters:

database - The PdbDatabase that is currently generated. Note that the database is still being read. The basic attributes are already read and may be used, but the appinfo and records are still incomplete. You would usually access the database to read the database name or creator.

Returns:

true if the converter is able to process the database records.

convert

T convert(PdbFile reader,
          int record,
          int size,
          int attribute,
          PdbDatabase<T,U> database)
   throws IOException

Converts raw record data to a Record object.

Parameters:

reader - PdbFile with the file cursor at the beginning of the record

record - Record number that is currently read

size - Size of this record, in bytes

attribute - Attributes of this record (unsigned byte)

database - The PdbDatabase that is currently generated. Note that the database is still being read. The attributes and appinfo are already read and may be used, but the records are still incomplete. You would usually access the database to read the database name or the category map.

Returns:

Record object containing the data of this record, or null if the raw data did not result in a record (e.g. because it was deleted).

Throws:

IOException

convertAppInfo

U convertAppInfo(PdbFile reader,
                 int size,
                 PdbDatabase<T,U> database)
          throws IOException

Converts raw application info data to an AppInfo.

Parameters:

reader - PdbFile with the file cursor at the beginning of the appinfo area

size - Estimated size of the appinfo area, in bytes. Note that the actual appinfo area might be smaller.

database - The PdbDatabase that is currently generated. Note that the database is still being read. The simple attributes are already read and may be used, but the appinfo and records are still empty. Usually you would like to ignore this parameter if possible.

Returns:

AppInfo object containing the converted appinfo

Throws:

IOException