src/java/org/apache/poi/hssf/record/UncalcedRecord.java

   1 /* ====================================================================
   2    Licensed to the Apache Software Foundation (ASF) under one or more
   3    contributor license agreements.  See the NOTICE file distributed with
   4    this work for additional information regarding copyright ownership.
   5    The ASF licenses this file to You under the Apache License, Version 2.0
   6    (the "License"); you may not use this file except in compliance with
   7    the License.  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 package org.apache.poi.hssf.record;
  19
  20 import org.apache.poi.util.LittleEndian;
  21
  22 /**
  23  * Title: Uncalced Record
  24  * <P>
  25  * If this record occurs in the Worksheet Substream, it indicates that the formulas have not
  26  * been recalculated before the document was saved.
  27  *
  28  * @author Olivier Leprince
  29  */
  30
  31 public class UncalcedRecord extends Record
  32 {
  33         public final static short sid = 0x5E;
  34
  35         /**
  36          * Default constructor
  37          */
  38         public UncalcedRecord() {
  39         }
  40         /**
  41          * read constructor
  42          */
  43         public UncalcedRecord(RecordInputStream in) {
  44                 super(in);
  45         }
  46
  47         public short getSid() {
  48                 return sid;
  49         }
  50
  51         protected void validateSid(short id) {
  52                 if (id != sid) {
  53                         throw new RecordFormatException("NOT AN UNCALCED RECORD");
  54                 }
  55         }
  56
  57         protected void fillFields(RecordInputStream in) {
  58                 short unused = in.readShort();
  59         }
  60
  61         public String toString() {
  62                 StringBuffer buffer = new StringBuffer();
  63                 buffer.append("[UNCALCED]\n");
  64                 buffer.append("[/UNCALCED]\n");
  65                 return buffer.toString();
  66         }
  67
  68         public int serialize(int offset, byte[] data) {
  69                 LittleEndian.putShort(data, 0 + offset, sid);
  70                 LittleEndian.putShort(data, 2 + offset, (short) 2);
  71                 LittleEndian.putShort(data, 4 + offset, (short) 0); // unused
  72                 return getRecordSize();
  73         }
  74
  75         public int getRecordSize() {
  76                 return UncalcedRecord.getStaticRecordSize();
  77         }
  78
  79         public static int getStaticRecordSize() {
  80                 return 6;
  81         }
  82 }