Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.ss.usermodel
Class WorkbookFactory

    java.lang.Object
      org.apache.poi.ss.usermodel.WorkbookFactory

    public class WorkbookFactory

extends java.lang.Object

Factory for creating the appropriate kind of Workbook (be it `HSSFWorkbook` or `XSSFWorkbook`), by auto-detecting from the supplied input.

Constructor Summary
`WorkbookFactory()`

Method Summary
`static Workbook` | `create(java.io.File file)` Creates the appropriate HSSFWorkbook / XSSFWorkbook from the given File, which must exist and be readable.
`static Workbook` | `create(java.io.File file, java.lang.String password)` Creates the appropriate HSSFWorkbook / XSSFWorkbook from the given File, which must exist and be readable, and may be password protected
`static Workbook` | `create(java.io.File file, java.lang.String password, boolean readOnly)` Creates the appropriate HSSFWorkbook / XSSFWorkbook from the given File, which must exist and be readable, and may be password protected
`static Workbook` | `create(java.io.InputStream inp)` Creates the appropriate HSSFWorkbook / XSSFWorkbook from the given InputStream.
`static Workbook` | `create(java.io.InputStream inp, java.lang.String password)` Creates the appropriate HSSFWorkbook / XSSFWorkbook from the given InputStream, which may be password protected.
`static Workbook` | `create(NPOIFSFileSystem fs)` Creates a HSSFWorkbook from the given NPOIFSFileSystem
`static Workbook` | `create(OPCPackage pkg)` Creates a XSSFWorkbook from the given OOXML Package
`static Workbook` | `create(POIFSFileSystem fs)` Creates a HSSFWorkbook from the given POIFSFileSystem

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### WorkbookFactory

    public WorkbookFactory()

Method Detail

### create

    public static Workbook create(POIFSFileSystem fs)
                           throws java.io.IOException

  Creates a HSSFWorkbook from the given POIFSFileSystem

  Note that in order to properly release resources the Workbook should be closed after use.

  Throws:
    `java.io.IOException`

### create

    public static Workbook create(NPOIFSFileSystem fs)
                           throws java.io.IOException

  Creates a HSSFWorkbook from the given NPOIFSFileSystem

  Note that in order to properly release resources the Workbook should be closed after use.

  Throws:
    `java.io.IOException`

### create

    public static Workbook create(OPCPackage pkg)
                           throws java.io.IOException

  Creates a XSSFWorkbook from the given OOXML Package

  Note that in order to properly release resources the Workbook should be closed after use.

  Parameters:
    `pkg` - The `OPCPackage` opened for reading data.
  Returns:
    The created Workbook
  Throws:
    `java.io.IOException` - if an error occurs while reading the data

### create

    public static Workbook create(java.io.InputStream inp)
                           throws java.io.IOException,
                                  InvalidFormatException,
                                  EncryptedDocumentException

  Creates the appropriate HSSFWorkbook / XSSFWorkbook from the given InputStream.

  Your input stream MUST either support mark/reset, or be wrapped as a `BufferedInputStream`! Note that using an `InputStream` has a higher memory footprint than using a `File`.

  Note that in order to properly release resources the Workbook should be closed after use. Note also that loading from an InputStream requires more memory than loading from a File, so prefer `create(File)` where possible.

  Parameters:
    `inp` - The `InputStream` to read data from.
  Returns:
    The created Workbook
  Throws:
    `java.io.IOException` - if an error occurs while reading the data
    `InvalidFormatException` - if the contents of the file cannot be parsed into a `Workbook`
    `EncryptedDocumentException` - If the workbook given is password protected

### create

    public static Workbook create(java.io.InputStream inp,
                                  java.lang.String password)
                           throws java.io.IOException,
                                  InvalidFormatException,
                                  EncryptedDocumentException

  Creates the appropriate HSSFWorkbook / XSSFWorkbook from the given InputStream, which may be password protected.

  Note that using an `InputStream` has a higher memory footprint than using a `File`.

  Note that in order to properly release resources the Workbook should be closed after use. Note also that loading from an InputStream requires more memory than loading from a File, so prefer `create(File)` where possible.

  Parameters:
    `inp` - The `InputStream` to read data from.
    `password` - The password that should be used or null if no password is necessary.
  Returns:
    The created Workbook
  Throws:
    `java.io.IOException` - if an error occurs while reading the data
    `InvalidFormatException` - if the contents of the file cannot be parsed into a `Workbook`
    `EncryptedDocumentException` - If the wrong password is given for a protected file
    `EmptyFileException` - If an empty stream is given

### create

    public static Workbook create(java.io.File file)
                           throws java.io.IOException,
                                  InvalidFormatException,
                                  EncryptedDocumentException

  Creates the appropriate HSSFWorkbook / 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.

  Parameters:
    `file` - The file to read data from.
  Returns:
    The created Workbook
  Throws:
    `java.io.IOException` - if an error occurs while reading the data
    `InvalidFormatException` - if the contents of the file cannot be parsed into a `Workbook`
    `EncryptedDocumentException` - If the workbook given is password protected

### create

    public static Workbook create(java.io.File file,
                                  java.lang.String password)
                           throws java.io.IOException,
                                  InvalidFormatException,
                                  EncryptedDocumentException

  Creates the appropriate HSSFWorkbook / XSSFWorkbook from the given File, which must exist and be readable, and may be password protected

  Note that in order to properly release resources the Workbook should be closed after use.

  Parameters:
    `file` - The file to read data from.
    `password` - The password that should be used or null if no password is necessary.
  Returns:
    The created Workbook
  Throws:
    `java.io.IOException` - if an error occurs while reading the data
    `InvalidFormatException` - if the contents of the file cannot be parsed into a `Workbook`
    `EncryptedDocumentException` - If the wrong password is given for a protected file
    `EmptyFileException` - If an empty stream is given

### create

    public static Workbook create(java.io.File file,
                                  java.lang.String password,
                                  boolean readOnly)
                           throws java.io.IOException,
                                  InvalidFormatException,
                                  EncryptedDocumentException

  Creates the appropriate HSSFWorkbook / XSSFWorkbook from the given File, which must exist and be readable, and may be password protected

  Note that in order to properly release resources the Workbook should be closed after use.

  Parameters:
    `file` - The file to read data from.
    `password` - The password that should be used or null if no password is necessary.
    `readOnly` - If the Workbook should be opened in read-only mode to avoid writing back changes when the document is closed.
  Returns:
    The created Workbook
  Throws:
    `java.io.IOException` - if an error occurs while reading the data
    `InvalidFormatException` - if the contents of the file cannot be parsed into a `Workbook`
    `EncryptedDocumentException` - If the wrong password is given for a protected file
    `EmptyFileException` - If an empty stream is given

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.