org.apache.poi.poifs.common.POIFSConstants Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of poi Show documentation

Apache POI - Java API To Access Microsoft Format Files

There is a newer version: 5.2.5


/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */


package org.apache.poi.poifs.common;

/**
 * A repository for constants shared by POI classes.
 */
public interface POIFSConstants
{
    /** Most files use 512 bytes as their big block size */
    int SMALLER_BIG_BLOCK_SIZE = 0x0200;
    POIFSBigBlockSize SMALLER_BIG_BLOCK_SIZE_DETAILS =
       new POIFSBigBlockSize(SMALLER_BIG_BLOCK_SIZE, (short)9);
    /** Some use 4096 bytes */
    int LARGER_BIG_BLOCK_SIZE = 0x1000;
    POIFSBigBlockSize LARGER_BIG_BLOCK_SIZE_DETAILS =
       new POIFSBigBlockSize(LARGER_BIG_BLOCK_SIZE, (short)12);

    /** How big a block in the small block stream is. Fixed size */
    int SMALL_BLOCK_SIZE = 0x0040;

    /** How big a single property is */
    int PROPERTY_SIZE  = 0x0080;

    /**
     * The minimum size of a document before it's stored using
     *  Big Blocks (normal streams). Smaller documents go in the
     *  Mini Stream (SBAT / Small Blocks)
     */
    int BIG_BLOCK_MINIMUM_DOCUMENT_SIZE = 0x1000;

    /** The highest sector number you're allowed, 0xFFFFFFFA */
    int LARGEST_REGULAR_SECTOR_NUMBER = -5;

    /** Indicates the sector holds a DIFAT block (0xFFFFFFFC) */
    int DIFAT_SECTOR_BLOCK   = -4;
    /** Indicates the sector holds a FAT block (0xFFFFFFFD) */
    int FAT_SECTOR_BLOCK   = -3;
    /** Indicates the sector is the end of a chain (0xFFFFFFFE) */
    int END_OF_CHAIN   = -2;
    /** Indicates the sector is not used (0xFFFFFFFF) */
    int UNUSED_BLOCK   = -1;
}