src/java/org/apache/poi/hssf/record/EOFRecord.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  * 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 public final class EOFRecord extends Record {
  33     public final static short sid = 0x0A;
  34         public static final int ENCODED_SIZE = 4;
  35
  36         public static final EOFRecord instance = new EOFRecord();
  37
  38     private EOFRecord() {
  39         // no data fields
  40     }
  41
  42     /**
  43      * @param in unused (since this record has no data)
  44      */
  45     public EOFRecord(RecordInputStream in)
  46     {
  47     }
  48
  49     public String toString()
  50     {
  51         StringBuffer buffer = new StringBuffer();
  52
  53         buffer.append("[EOF]\n");
  54         buffer.append("[/EOF]\n");
  55         return buffer.toString();
  56     }
  57
  58     public int serialize(int offset, byte [] data)
  59     {
  60         LittleEndian.putShort(data, 0 + offset, sid);
  61         LittleEndian.putShort(data, 2 + offset,
  62                               (( short ) 0));   // no record info
  63         return getRecordSize();
  64     }
  65
  66     public int getRecordSize()
  67     {
  68         return ENCODED_SIZE;
  69     }
  70
  71     public short getSid()
  72     {
  73         return sid;
  74     }
  75
  76     public Object clone() {
  77       return instance;
  78     }
  79 }