KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > poi > hssf > record > BackupRecord


1
2 /* ====================================================================
3    Copyright 2002-2004 Apache Software Foundation
4
5    Licensed under the Apache License, Version 2.0 (the "License");
6    you may not use this file except in compliance with the License.
7    You may obtain a copy of the License at
8
9        http://www.apache.org/licenses/LICENSE-2.0
10
11    Unless required by applicable law or agreed to in writing, software
12    distributed under the License is distributed on an "AS IS" BASIS,
13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14    See the License for the specific language governing permissions and
15    limitations under the License.
16 ==================================================================== */
17         
18
19 package org.apache.poi.hssf.record;
20
21 import org.apache.poi.util.LittleEndian;
22
23 /**
24  * Title: Backup Record <P>
25  * Description: Boolean specifying whether
26  * the GUI should store a backup of the file.<P>
27  * REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
28  * @author Andrew C. Oliver (acoliver at apache dot org)
29  * @version 2.0-pre
30  */
31
32 public class BackupRecord
33     extends Record
34 {
35     public final static short sid = 0x40;
36     private short field_1_backup; // = 0;
37
38     public BackupRecord()
39     {
40     }
41
42     /**
43      * Constructs a BackupRecord and sets its fields appropriately
44      *
45      * @param id id must be 0x40 or an exception will be throw upon validation
46      * @param size the size of the data area of the record
47      * @param data data of the record (should not contain sid/len)
48      */
49
50     public BackupRecord(short id, short size, byte [] data)
51     {
52         super(id, size, data);
53     }
54
55     /**
56      * Constructs a BackupRecord and sets its fields appropriately
57      *
58      * @param id id must be 0x40 or an exception will be throw upon validation
59      * @param size the size of the data area of the record
60      * @param data data of the record (should not contain sid/len)
61      * @param offset of the start of the record's data
62      */
63
64     public BackupRecord(short id, short size, byte [] data, int offset)
65     {
66         super(id, size, data, offset);
67     }
68
69     protected void validateSid(short id)
70     {
71         if (id != sid)
72         {
73             throw new RecordFormatException("NOT A BACKUP RECORD");
74         }
75     }
76
77     protected void fillFields(byte [] data, short size, int offset)
78     {
79         field_1_backup = LittleEndian.getShort(data, 0 + offset);
80     }
81
82     /**
83      * set the backup flag (0,1)
84      *
85      * @param backup backup flag
86      */
87
88     public void setBackup(short backup)
89     {
90         field_1_backup = backup;
91     }
92
93     /**
94      * get the backup flag
95      *
96      * @return short 0/1 (off/on)
97      */
98
99     public short getBackup()
100     {
101         return field_1_backup;
102     }
103
104     public String JavaDoc toString()
105     {
106         StringBuffer JavaDoc buffer = new StringBuffer JavaDoc();
107
108         buffer.append("[BACKUP]\n");
109         buffer.append(" .backup = ")
110             .append(Integer.toHexString(getBackup())).append("\n");
111         buffer.append("[/BACKUP]\n");
112         return buffer.toString();
113     }
114
115     public int serialize(int offset, byte [] data)
116     {
117         LittleEndian.putShort(data, 0 + offset, sid);
118         LittleEndian.putShort(data, 2 + offset,
119                               (( short ) 0x02)); // 2 bytes (6 total)
120 LittleEndian.putShort(data, 4 + offset, getBackup());
121         return getRecordSize();
122     }
123
124     public int getRecordSize()
125     {
126         return 6;
127     }
128
129     public short getSid()
130     {
131         return this.sid;
132     }
133 }
134
Popular Tags