Mirror of Apache POI
Go to file
Dominik Stadler 0f290fe501 Adjust file-handle-leak exlusions
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1907107 13f79535-47bb-0310-9956-ffa450edef68
2023-01-30 12:19:33 +00:00
.github update xmlbeans 2022-08-19 15:04:29 +00:00
gradle/wrapper remove gradle plugin that is causing build problems 2022-11-26 00:47:03 +00:00
jenkins Jenkins DSL: Fix link to Spotbugs results some more 2023-01-01 15:59:16 +00:00
legal 2023 2023-01-01 23:04:10 +00:00
lib.stored Store jars for svnant locally 2021-04-10 07:16:57 +00:00
osgi test with log4j 2.19.0 rc1 2022-09-13 10:48:55 +00:00
poi Bug 54373: Include alpha/transparency value when creating an XSSFColor from an AWT Color object 2023-01-30 12:19:31 +00:00
poi-examples Saxon-HE is included in more place, combine these into the main gradle build 2023-01-06 19:58:45 +00:00
poi-excelant revert ant upgrade due to issues with ant-launcher-1.10.13.jar 2023-01-10 20:59:59 +00:00
poi-integration revert ant upgrade due to issues with ant-launcher-1.10.13.jar 2023-01-10 21:36:34 +00:00
poi-ooxml Bug 54373: Include alpha/transparency value when creating an XSSFColor from an AWT Color object 2023-01-30 12:19:31 +00:00
poi-ooxml-full try to get rid of cached module-info classes 2022-12-27 18:45:15 +00:00
poi-ooxml-lite try to get rid of cached module-info classes 2022-12-27 18:45:15 +00:00
poi-ooxml-lite-agent byte-buddy 1.12.22 2023-01-13 12:08:02 +00:00
poi-scratchpad Saxon-HE is included in more place, combine these into the main gradle build 2023-01-06 19:58:45 +00:00
src/resources [bug-66365] rework XSSFCell getRichStringCellValue and getStringCellValue to better support array formula results. Thanks to Espen Amble Kolstad. 2022-11-28 13:05:45 +00:00
test-data Bug 62272: Include alpha/transparency value when setting a color-value for a font 2023-01-30 12:19:24 +00:00
.asf.yaml github config 2021-11-14 11:36:33 +00:00
.gitattributes Add .gitattribute file and set lf for one sample-file, see bug 61609 2018-01-01 14:39:19 +00:00
.gitignore Ignore compile module-info class-files 2023-01-01 15:59:37 +00:00
KEYS update key 2022-06-02 08:37:32 +00:00
README.rst build details 2021-12-21 12:13:18 +00:00
SECURITY.md add SECURITY.md 2021-11-05 08:39:11 +00:00
build.gradle revert to saxon 11.4 (saxon 12.0 only supports Java 11) 2023-01-17 18:56:47 +00:00
build.xml junit-platform 1.9.2 2023-01-29 21:15:58 +00:00
doap_POI.rdf prep 5.2.3 release 2022-09-16 21:07:53 +00:00
file-leak-detector.exclude Adjust file-handle-leak exlusions 2023-01-30 12:19:33 +00:00
gradle.properties revert gradle memory change 2022-02-22 17:16:21 +00:00
gradlew remove gradle plugin that is causing build problems 2022-11-26 00:47:03 +00:00
gradlew.bat remove gradle plugin that is causing build problems 2022-11-26 00:47:03 +00:00
patch.xml Tweak 2016-08-02 08:31:52 +00:00
settings.gradle Use parallel build to speed up building and running tests 2021-11-07 14:59:48 +00:00

README.rst

Apache POI
======================

A Java library for reading and writing Microsoft Office binary and OOXML file formats.

The Apache POI Project's mission is to create and maintain Java APIs for manipulating various file formats based upon the Office Open XML standards (OOXML) and Microsoft's OLE 2 Compound Document format (OLE2). In short, you can read and write MS Excel files using Java. In addition, you can read and write MS Word and MS PowerPoint files using Java. Apache POI is your Java Excel solution (for Excel 97-2008). We have a complete API for porting other OOXML and OLE2 formats and welcome others to participate.

OLE2 files include most Microsoft Office files such as XLS, DOC, and PPT as well as MFC serialization API based file formats. The project provides APIs for the OLE2 Filesystem (POIFS) and OLE2 Document Properties (HPSF).

Office OpenXML Format is the new standards based XML file format found in Microsoft Office 2007 and 2008. This includes XLSX, DOCX and PPTX. The project provides a low level API to support the Open Packaging Conventions using openxml4j.

For each MS Office application there exists a component module that attempts to provide a common high level Java api to both OLE2 and OOXML document formats. This is most developed for Excel workbooks (SS=HSSF+XSSF). Work is progressing for Word documents (WP=HWPF+XWPF) and PowerPoint presentations (SL=HSLF+XSLF).

The project has some support for Outlook (HSMF). Microsoft opened the specifications to this format in October 2007. We would welcome contributions.

There are also projects for Visio (HDGF and XDGF), TNEF (HMEF), and Publisher (HPBF).

This library includes the following components, roughly in descending order of maturity:

* Excel spreadsheets (Common SS = HSSF, XSSF, and SXSSF)
* PowerPoint slideshows (Common SL = HSLF and XSLF)
* Word processing documents (Common WP = HWPF and XWPF)
* Outlook email (HSMF and HMEF)
* Visio diagrams (HDGF and XDGF)
* Publisher (HPBF)

And lower-level, supporting components:

* OLE2 Filesystem (POIFS)
* OLE2 Document Properties (HPSF)
* TNEF (HMEF) for Outlook winmail.dat files
* OpenXML4J (OOXML)

| Components named H??F are for reading or writing OLE2 binary formats.
| Components named X??F are for reading or writing OpenOffice XML (OOXML) formats.

Getting started
------------------

Website: https://poi.apache.org/

`Mailing lists`_:

* `Developers`_
* `Users`_
* `General`_ (release announcements)

Bug tracker:

* `Bugzilla`_
* `GitHub pull requests`_

Source code:

* Official `Apache Subversion repo`_ at apache.org
* `ViewVC repo browser`_ at apache.org
* `GitHub git mirror`_ at github.com

Requires Java 1.8 or later.

Contributing
------------------

* Download and install svn or git, Java JDK 1.8+, and Apache Ant 1.8+ or Gradle

* Check out the code from svn or git

* Import the project into Eclipse or your favorite IDE

* Write a unit test:

  * Binary formats and Common APIs: poi/src/test/java/org/apache/poi/
  * OOXML APIs only: poi-ooxml/src/test/java/org/apache/poi/
  * Scratchpad (Binary formats): poi-scratchpad/src/test/java/org/apache/poi/
  * Test files: test-data/

* Navigate the source, make changes, and run unit tests to verify

  * Binary formats and Common APIs: poi/src/main/java/org/apache/poi/
  * OOXML APIs only: poi-ooxml/src/main/java/org/apache/poi/
  * Scratchpad (Binary formats): poi-scratchpad/src/main/java/org/apache/poi/
  * Examples: poi-examples/src/main/java/org/apache/poi/

* More info: `How To Build page`_  at apache.org

Building jar files
------------------

To build the jar files for poi, poi-ooxml, poi-ooxml-lite, poi-ooxml-full and poi-examples::

    ./gradlew jar

    gradlew jar

.. _Mailing lists: https://poi.apache.org/mailinglists.html
.. _Developers: https://lists.apache.org/list.html?dev@poi.apache.org
.. _Users: https://lists.apache.org/list.html?user@poi.apache.org
.. _General: https://lists.apache.org/list.html?general@poi.apache.org
.. _Bugzilla: https://bz.apache.org/bugzilla/buglist.cgi?product=POI
.. _GitHub pull requests: https://github.com/apache/poi/pulls

.. _Apache Subversion repo: https://svn.apache.org/repos/asf/poi/trunk
.. _ViewVC repo browser: https://svn.apache.org/viewvc/poi/trunk
.. _GitHub git mirror: https://github.com/apache/poi
.. _How To Build page: http://poi.apache.org/devel/