diff options
Diffstat (limited to 'xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbHeader.java')
| -rw-r--r-- | xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbHeader.java | 83 |
1 files changed, 38 insertions, 45 deletions
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbHeader.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbHeader.java index fc8303111557..280c6e3dbcf5 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbHeader.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbHeader.java @@ -23,89 +23,85 @@ import java.io.DataOutput; import java.io.IOException; /** - * <p>Class used only internally by <code>PdbEncoder</code> and - * <code>PdbDecoder</code> to store, read and write a PDB header.</p> + * Class used only internally by {@code PdbEncoder} and {@code PdbDecoder} to + * store, read and write a PDB header. * - * <p>Note that fields are intended to be accessible only at the - * package level.</p> + * <p>Note that fields are intended to be accessible only at the package + * level.</p> * - * <p>Some of the fields are internally represented using a - * larger type since Java does not have unsigned types. - * Some are not since they are not relevant for now. - * The <code>read</code> and <code>write</code> methods should - * handle them properly.</p> + * <p>Some of the fields are internally represented using a larger type since + * Java does not have unsigned types. Some are not since they are not relevant + * for now. The {@code read} and {@code write} methods should handle them + * properly.</p> * - * @see PalmDB - * @see Record + * @see PalmDB + * @see Record */ final class PdbHeader { - - /** Name of the database. 32 bytes. */ + /** Name of the database. 32 bytes. */ byte[] pdbName = null; /** - * Flags for the database. Palm UInt16. Unsignedness should be - * irrelevant. + * Flags for the database. Palm UInt16. Unsignedness should be irrelevant. */ short attribute = 0; - /** Application-specific version for the database. Palm UInt16. */ + /** Application-specific version for the database. Palm UInt16. */ int version = 0; - /** Date created. Palm UInt32. */ + /** Date created. Palm UInt32. */ long creationDate = 0; - /** Date last modified. Palm UInt32. */ + /** Date last modified. Palm UInt32. */ long modificationDate = 0; - /** Date last backup. Palm UInt32. */ + /** Date last backup. Palm UInt32. */ private long lastBackupDate = 0; /** - * Incremented every time a <code>Record</code> is - * added, deleted or modified. Palm UInt32. + * Incremented every time a {@code Record} is added, deleted or modified. + * Palm UInt32. */ private long modificationNumber = 0; - /** Optional field. Palm UInt32. Unsignedness should be irrelevant. */ + /** Optional field. Palm UInt32. Unsignedness should be irrelevant. */ private int appInfoID = 0; - /** Optional field. Palm UInt32. Unsignedness should be irrelevant. */ + /** Optional field. Palm UInt32. Unsignedness should be irrelevant. */ private int sortInfoID = 0; - /** Database type ID. Palm UInt32. Unsignedness should be irrelevant. */ + /** Database type ID. Palm UInt32. Unsignedness should be irrelevant. */ int typeID = 0; - /** Database creator ID. Palm UInt32. Unsignedness should be irrelevant. */ + /** Database creator ID. Palm UInt32. Unsignedness should be irrelevant. */ int creatorID = 0; - /** ??? */ + /** ??? */ private int uniqueIDSeed = 0; - /** See numRecords. 4 bytes. */ + /** See numRecords. 4 bytes. */ private int nextRecordListID = 0; /** - * Number of Records stored in the database header. - * If all the <code>Record</code> entries cannot fit in the header, - * then <code>nextRecordList</code> has the local ID of a - * RecordList that contains the next set of <code>Record</code>. - * Palm UInt16. + * Number of Records stored in the database header. + * If all the {@code Record} entries cannot fit in the header, then + * {@code nextRecordList} has the local ID of a RecordList that contains + * the next set of {@code Record}. + * Palm UInt16. */ int numRecords = 0; - /** - * Read in the data for the PDB header. Need to - * preserve the unsigned value for some of the fields. + * Read in the data for the PDB header. * - * @param in A <code>DataInput</code> object. + * <p>Need to preserve the unsigned value for some of the fields.</p> * - * @throws IOException If any I/O error occurs. + * @param in A {@code DataInput} object. + * + * @throws IOException If any I/O error occurs. */ public void read(DataInput in) throws IOException { - pdbName = new byte[PalmDB.NAME_LENGTH]; in.readFully(pdbName); attribute = in.readShort(); @@ -123,16 +119,14 @@ final class PdbHeader { numRecords = in.readUnsignedShort(); } - /** - * Write out PDB header data. + * Write out PDB header data. * - * @param out A <code>DataOutput</code> object. + * @param out A {@code DataOutput} object. * - * @throws IOException If any I/O error occurs. + * @throws IOException If any I/O error occurs. */ public void write(DataOutput out) throws IOException { - out.write(pdbName); out.writeShort(attribute); out.writeShort(version); @@ -148,5 +142,4 @@ final class PdbHeader { out.writeInt(nextRecordListID); out.writeShort(numRecords); } -} - +}
\ No newline at end of file |