org.shredzone.pdbconverter.pdb.converter

Class TodoConverter

java.lang.Object

org.shredzone.pdbconverter.pdb.converter.TodoConverter

All Implemented Interfaces:

Converter<TodoRecord,CategoryAppInfo>

public class TodoConverter
extends Object
implements Converter<TodoRecord,CategoryAppInfo>

A Converter that handles todo records.

Author:

Richard "Shred" Körber

Constructor Summary

Constructors

Constructor and Description
TodoConverter()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TodoConverter

public TodoConverter()

Method Detail

isAcceptable

public boolean isAcceptable(PdbDatabase<TodoRecord,CategoryAppInfo> database)

Description copied from interface: Converter

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

Specified by:

isAcceptable in interface Converter<TodoRecord,CategoryAppInfo>

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

public TodoRecord convert(PdbFile reader,
                          int record,
                          int size,
                          int attribute,
                          PdbDatabase<TodoRecord,CategoryAppInfo> database)
                   throws IOException

Description copied from interface: Converter

Converts raw record data to a Record object.

Specified by:

convert in interface Converter<TodoRecord,CategoryAppInfo>

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

public CategoryAppInfo convertAppInfo(PdbFile reader,
                                      int size,
                                      PdbDatabase<TodoRecord,CategoryAppInfo> database)
                               throws IOException

Description copied from interface: Converter

Converts raw application info data to an AppInfo.

Specified by:

convertAppInfo in interface Converter<TodoRecord,CategoryAppInfo>

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