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: * The begin record defines the start of a block of records for a (grpahing
24: * data object. This record is matched with a corresponding EndRecord.
25: *
26: * @see EndRecord
27: *
28: * @author Glen Stampoultzis (glens at apache.org)
29: */
30:
31: public class BeginRecord extends Record {
32: public static final short sid = 0x1033;
33:
34: public BeginRecord() {
35: }
36:
37: /**
38: * Constructs a BeginRecord record and sets its fields appropriately.
39: * @param in the RecordInputstream to read the record from
40: */
41:
42: public BeginRecord(RecordInputStream in) {
43: super (in);
44: }
45:
46: protected void validateSid(short id) {
47: if (id != sid) {
48: throw new RecordFormatException("NOT A BEGIN RECORD");
49: }
50: }
51:
52: protected void fillFields(RecordInputStream in) {
53: }
54:
55: public String toString() {
56: StringBuffer buffer = new StringBuffer();
57:
58: buffer.append("[BEGIN]\n");
59: buffer.append("[/BEGIN]\n");
60: return buffer.toString();
61: }
62:
63: public int serialize(int offset, byte[] data) {
64: LittleEndian.putShort(data, 0 + offset, sid);
65: LittleEndian.putShort(data, 2 + offset, ((short) 0)); // no record info
66: return getRecordSize();
67: }
68:
69: public int getRecordSize() {
70: return 4;
71: }
72:
73: public short getSid() {
74: return sid;
75: }
76: }
|