org.apache.poi.xssf.usermodel.XSSFWorkbookFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of poi-ooxml 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.xssf.usermodel;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;

import org.apache.poi.EncryptedDocumentException;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.openxml4j.opc.PackageAccess;
import org.apache.poi.openxml4j.opc.ZipPackage;
import org.apache.poi.ss.usermodel.WorkbookFactory;

public class XSSFWorkbookFactory extends WorkbookFactory {

    /**
     * Creates a XSSFWorkbook from the given OOXML Package.
     * This is a convenience method to go along the create-methods of the super class.
     *
     * Note that in order to properly release resources the
     *  Workbook should be closed after use.
     *
     *  @param pkg The {@link OPCPackage} opened for reading data.
     *
     *  @return The created Workbook
     *
     *  @throws IOException if an error occurs while reading the data
     * @throws InvalidFormatException
     */
    public static XSSFWorkbook create(OPCPackage pkg) throws IOException {
        return createWorkbook(pkg);
    }

    /**
     * Creates a XSSFWorkbook from the given OOXML Package
     *
     * Note that in order to properly release resources the
     *  Workbook should be closed after use.
     *
     *  @param pkg The {@link ZipPackage} opened for reading data.
     *
     *  @return The created Workbook
     *
     *  @throws IOException if an error occurs while reading the data
     * @throws InvalidFormatException
     */
    public static XSSFWorkbook createWorkbook(ZipPackage pkg) throws IOException {
        return createWorkbook((OPCPackage)pkg);
    }

    /**
     * Creates a XSSFWorkbook from the given OOXML Package
     *
     * Note that in order to properly release resources the
     *  Workbook should be closed after use.
     *
     *  @param pkg The {@link OPCPackage} opened for reading data.
     *
     *  @return The created Workbook
     *
     *  @throws IOException if an error occurs while reading the data
     * @throws InvalidFormatException
     */
    public static XSSFWorkbook createWorkbook(OPCPackage pkg) throws IOException {
        try {
            return new XSSFWorkbook(pkg);
        } catch (RuntimeException ioe) {
            // ensure that file handles are closed (use revert() to not re-write the file)
            pkg.revert();
            //pkg.close();

            // rethrow exception
            throw ioe;
        }
    }

    /**
     * Creates the XSSFWorkbook from the given File, which must exist and be readable.
     * Note that in order to properly release resources the Workbook should be closed after use.
     *
     *  @param file The file to read data from.
     *  @param readOnly If the Workbook should be opened in read-only mode to avoid writing back
     *      changes when the document is closed.
     *
     *  @return The created Workbook
     *
     *  @throws IOException if an error occurs while reading the data
     *  @throws EncryptedDocumentException If the wrong password is given for a protected file
     */
    @SuppressWarnings("resource")
    public static XSSFWorkbook createWorkbook(File file, boolean readOnly)
            throws IOException, InvalidFormatException {
        OPCPackage pkg = OPCPackage.open(file, readOnly ? PackageAccess.READ : PackageAccess.READ_WRITE);
        return createWorkbook(pkg);
    }

    /**
     * Creates a XSSFWorkbook from the given InputStream
     *
     * 
Note that in order to properly release resources the
     * Workbook should be closed after use.
     *
     * @param stream The {@link InputStream} to read data from.
     *
     * @return The created Workbook
     *
     * @throws IOException if an error occurs while reading the data
     * @throws InvalidFormatException
     */
    @SuppressWarnings("resource")
    public static XSSFWorkbook createWorkbook(InputStream stream) throws IOException, InvalidFormatException {
        OPCPackage pkg = OPCPackage.open(stream);
        return createWorkbook(pkg);
    }


}