01: /* ====================================================================
02: Licensed to the Apache Software Foundation (ASF) under one or more
03: contributor license agreements. See the NOTICE file distributed with
04: this work for additional information regarding copyright ownership.
05: The ASF licenses this file to You under the Apache License, Version 2.0
06: (the "License"); you may not use this file except in compliance with
07: the License. You may obtain a copy of the License at
08:
09: 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: package org.apache.poi.hssf.record;
19:
20: import org.apache.poi.util.LittleEndian;
21:
22: /**
23: * End Of File record.
24: * <P>
25: * Description: Marks the end of records belonging to a particular object in the
26: * HSSF File<P>
27: * REFERENCE: PG 307 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
28: * @author Andrew C. Oliver (acoliver at apache dot org)
29: * @author Jason Height (jheight at chariot dot net dot au)
30: * @version 2.0-pre
31: */
32:
33: public class EOFRecord extends Record {
34: public final static short sid = 0x0A;
35:
36: public EOFRecord() {
37: }
38:
39: /**
40: * Constructs a EOFRecord record and sets its fields appropriately.
41: * @param in the RecordInputstream to read the record from
42: */
43:
44: public EOFRecord(RecordInputStream in) {
45: super (in);
46: }
47:
48: protected void validateSid(short id) {
49: if (id != sid) {
50: throw new RecordFormatException("NOT An EOF RECORD");
51: }
52: }
53:
54: protected void fillFields(RecordInputStream in) {
55: }
56:
57: public String toString() {
58: StringBuffer buffer = new StringBuffer();
59:
60: buffer.append("[EOF]\n");
61: buffer.append("[/EOF]\n");
62: return buffer.toString();
63: }
64:
65: public int serialize(int offset, byte[] data) {
66: LittleEndian.putShort(data, 0 + offset, sid);
67: LittleEndian.putShort(data, 2 + offset, ((short) 0)); // no record info
68: return getRecordSize();
69: }
70:
71: public int getRecordSize() {
72: return 4;
73: }
74:
75: public short getSid() {
76: return sid;
77: }
78:
79: public Object clone() {
80: EOFRecord rec = new EOFRecord();
81: return rec;
82: }
83: }
|