From 5f28881a3574b5e7999a73200afa32eddfd07295 Mon Sep 17 00:00:00 2001 From: Andreas Beeker Date: Sun, 1 Dec 2019 00:07:48 +0000 Subject: [PATCH] change package.html to package-info.java git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1870655 13f79535-47bb-0310-9956-ffa450edef68 --- .../poi/hssf/view/brush/package-info.java} | 19 +-- .../poi/ss/examples/html/package-info.java} | 21 +-- src/java/org/apache/poi/ddf/package-info.java | 22 +++ .../org/apache/poi/hpsf/package-info.java | 62 +++++++ src/java/org/apache/poi/hpsf/package.html | 159 ------------------ .../wellknown/package-info.java} | 32 ++-- .../apache/poi/hpsf/wellknown/package.html | 59 ------- .../apache/poi/hssf/dev/package-info.java} | 21 ++- src/java/org/apache/poi/hssf/dev/package.html | 36 ---- .../poi/hssf/eventusermodel/package-info.java | 25 +++ .../poi/hssf/eventusermodel/package.html | 41 ----- .../apache/poi/hssf/model/package-info.java | 23 +++ .../package.html => hssf/package-info.java} | 22 +-- .../record/aggregates/package-info.java} | 25 ++- .../poi/hssf/record/aggregates/package.html | 40 ----- .../apache/poi/hssf/record/package-info.java} | 23 ++- .../org/apache/poi/hssf/record/package.html | 39 ----- .../poi/hssf/usermodel/package-info.java | 21 +++ .../apache/poi/hssf/usermodel/package.html | 35 ---- .../apache/poi/hssf/util/package-info.java | 21 +++ .../org/apache/poi/hssf/util/package.html | 36 ---- .../apache/poi/ss/format/package-info.java | 21 +++ .../apache/poi/ss/formula/package-info.java | 22 +++ .../poi/ss/formula/ptg/package-info.java | 24 +++ .../apache/poi/ss/formula/ptg/package.html | 38 ----- .../org/apache/poi/util/package-info.java | 22 +++ src/java/org/apache/poi/util/package.html | 36 ---- .../apache/poi/xssf/binary/package-info.java} | 36 ++-- .../org/apache/poi/xssf/binary/package.html | 44 ----- .../org/apache/poi/xwpf/package-info.java | 22 +++ 30 files changed, 364 insertions(+), 683 deletions(-) rename src/{java/org/apache/poi/ss/format/package.html => examples/src/org/apache/poi/hssf/view/brush/package-info.java} (72%) rename src/{ooxml/java/org/apache/poi/xwpf/package.html => examples/src/org/apache/poi/ss/examples/html/package-info.java} (67%) create mode 100644 src/java/org/apache/poi/ddf/package-info.java create mode 100644 src/java/org/apache/poi/hpsf/package-info.java delete mode 100644 src/java/org/apache/poi/hpsf/package.html rename src/java/org/apache/poi/{hssf/package.html => hpsf/wellknown/package-info.java} (57%) delete mode 100644 src/java/org/apache/poi/hpsf/wellknown/package.html rename src/{examples/src/org/apache/poi/hssf/view/brush/package.html => java/org/apache/poi/hssf/dev/package-info.java} (71%) delete mode 100644 src/java/org/apache/poi/hssf/dev/package.html create mode 100644 src/java/org/apache/poi/hssf/eventusermodel/package-info.java delete mode 100644 src/java/org/apache/poi/hssf/eventusermodel/package.html create mode 100644 src/java/org/apache/poi/hssf/model/package-info.java rename src/java/org/apache/poi/{ss/formula/package.html => hssf/package-info.java} (66%) rename src/java/org/apache/poi/{ddf/package.html => hssf/record/aggregates/package-info.java} (63%) delete mode 100644 src/java/org/apache/poi/hssf/record/aggregates/package.html rename src/{examples/src/org/apache/poi/ss/examples/html/package.html => java/org/apache/poi/hssf/record/package-info.java} (69%) delete mode 100644 src/java/org/apache/poi/hssf/record/package.html create mode 100644 src/java/org/apache/poi/hssf/usermodel/package-info.java delete mode 100644 src/java/org/apache/poi/hssf/usermodel/package.html create mode 100644 src/java/org/apache/poi/hssf/util/package-info.java delete mode 100644 src/java/org/apache/poi/hssf/util/package.html create mode 100644 src/java/org/apache/poi/ss/format/package-info.java create mode 100644 src/java/org/apache/poi/ss/formula/package-info.java create mode 100644 src/java/org/apache/poi/ss/formula/ptg/package-info.java delete mode 100644 src/java/org/apache/poi/ss/formula/ptg/package.html create mode 100644 src/java/org/apache/poi/util/package-info.java delete mode 100644 src/java/org/apache/poi/util/package.html rename src/{java/org/apache/poi/hssf/model/package.html => ooxml/java/org/apache/poi/xssf/binary/package-info.java} (55%) delete mode 100644 src/ooxml/java/org/apache/poi/xssf/binary/package.html create mode 100644 src/ooxml/java/org/apache/poi/xwpf/package-info.java diff --git a/src/java/org/apache/poi/ss/format/package.html b/src/examples/src/org/apache/poi/hssf/view/brush/package-info.java similarity index 72% rename from src/java/org/apache/poi/ss/format/package.html rename to src/examples/src/org/apache/poi/hssf/view/brush/package-info.java index 4c0096d3c4..cf71cf6a13 100644 --- a/src/java/org/apache/poi/ss/format/package.html +++ b/src/examples/src/org/apache/poi/hssf/view/brush/package-info.java @@ -1,6 +1,4 @@ - - - - - - -This package contains classes that implement cell formatting - - +==================================================================== */ + +/** + * This package contains some brushes that are used when drawing borders for Excel cells. + */ +package org.apache.poi.hssf.view.brush; \ No newline at end of file diff --git a/src/ooxml/java/org/apache/poi/xwpf/package.html b/src/examples/src/org/apache/poi/ss/examples/html/package-info.java similarity index 67% rename from src/ooxml/java/org/apache/poi/xwpf/package.html rename to src/examples/src/org/apache/poi/ss/examples/html/package-info.java index 0a59556461..11b5fd5914 100644 --- a/src/ooxml/java/org/apache/poi/xwpf/package.html +++ b/src/examples/src/org/apache/poi/ss/examples/html/package-info.java @@ -1,6 +1,4 @@ - - - - -

This package contains classes for handling Microsoft .docx - Word Processing files, known in POI as XWPF (XML Word Processing - Format). -

- - +==================================================================== */ + +/** + * This package contains an example that uses POI to convert a workbook into + * an HTML representation of the data. It can use both XSSF and HSSF workbooks. + */ +package org.apache.poi.ss.examples.html; \ No newline at end of file diff --git a/src/java/org/apache/poi/ddf/package-info.java b/src/java/org/apache/poi/ddf/package-info.java new file mode 100644 index 0000000000..b748cf8175 --- /dev/null +++ b/src/java/org/apache/poi/ddf/package-info.java @@ -0,0 +1,22 @@ +/* ==================================================================== + 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. +==================================================================== */ + +/** + * This package contains classes for decoding the Microsoft Office Drawing format otherwise + * known as escher henceforth known in POI as the Dreadful Drawing Format. + */ +package org.apache.poi.ddf; \ No newline at end of file diff --git a/src/java/org/apache/poi/hpsf/package-info.java b/src/java/org/apache/poi/hpsf/package-info.java new file mode 100644 index 0000000000..a07740c96f --- /dev/null +++ b/src/java/org/apache/poi/hpsf/package-info.java @@ -0,0 +1,62 @@ +/* ==================================================================== + 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. +==================================================================== */ + +/** + * Processes streams in the Horrible Property Set Format (HPSF) in POI filesystems. + * Microsoft Office documents, i.e. POI filesystems, usually contain meta data like author, title, + * last saving time etc. These items are called properties and stored in + * property set streams along with the document itself. + * These streams are commonly named {@code \005SummaryInformation} and {@code \005DocumentSummaryInformation}. + * However, a POI filesystem may contain further property sets of other names or types. + *

+ * In order to extract the properties from a POI filesystem, a property set stream's contents must be parsed into a + * {@link org.apache.poi.hpsf.PropertySet} instance. Its subclasses {@link org.apache.poi.hpsf.SummaryInformation} + * and {@link org.apache.poi.hpsf.DocumentSummaryInformation} deal with the well-known property set streams + * {@code \005SummaryInformation} and {@code \005DocumentSummaryInformation}. + * (However, the streams' names are irrelevant. What counts is the property set's first section's format ID - see below.) + *

+ * The factory method {@link org.apache.poi.hpsf.PropertySetFactory#create} creates a PropertySet instance. + * This method always returns the most specific property set: + * If it identifies the stream data as a Summary Information or as a Document Summary Information it returns an + * instance of the corresponding class, else the general PropertySet. + *

+ * A PropertySet contains a list of {@link org.apache.poi.hpsf.Section Sections} which can be + * retrieved with {@link org.apache.poi.hpsf.PropertySet#getSections}. Each Section contains a + * {@link org.apache.poi.hpsf.Property} array which can be retrieved with + * {@link org.apache.poi.hpsf.Section#getProperties}. Since the vast majority of PropertySets contains only a single Section, + * the convenience method {@link org.apache.poi.hpsf.PropertySet#getProperties} returns the properties of a + * PropertySets Section (throwing a {@link org.apache.poi.hpsf.NoSingleSectionException} if the PropertySet contains + * more (or less) than exactly one Section). + *

+ * Each Property has an ID, a type, and a value which can be + * retrieved with {@link org.apache.poi.hpsf.Property#getID}, {@link org.apache.poi.hpsf.Property#getType}, + * and {@link org.apache.poi.hpsf.Property#getValue}, respectively. The value's class depends on the property's type. + * The current implementation does not yet support all property types and restricts the values' classes + * to String, Integer and Date. A value of a yet unknown type is returned as a byte array containing the values + * origin bytes from the property set stream. + *

+ * To retrieve the value of a specific Property, use {@link org.apache.poi.hpsf.Section#getProperty} or + * {@link org.apache.poi.hpsf.Section#getPropertyIntValue}. + *

+ * The SummaryInformation and DocumentSummaryInformation classes provide convenience methods for retrieving well-known + * properties. For example, an application that wants to retrieve a document's title string just calls + * {@link org.apache.poi.hpsf.SummaryInformation#getTitle} instead of going through the hassle of first finding out + * what the title's property ID is and then using this ID to get the property's value. + * + * @see [MS-OLEPS] Object Linking and Embedding (OLE) Property Set Data Structures + */ +package org.apache.poi.hpsf; \ No newline at end of file diff --git a/src/java/org/apache/poi/hpsf/package.html b/src/java/org/apache/poi/hpsf/package.html deleted file mode 100644 index 028495999a..0000000000 --- a/src/java/org/apache/poi/hpsf/package.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - HPSF - - - -

-

Processes streams in the Horrible Property Set Format (HPSF) in POI - filesystems. Microsoft Office documents, i.e. POI filesystems, usually - contain meta data like author, title, last saving time etc. These items - are called properties and stored in - property set streams along with the document itself. These - streams are commonly named \005SummaryInformation and - \005DocumentSummaryInformation. However, a POI filesystem may - contain further property sets of other names or types.

- -

In order to extract the properties from a POI filesystem, a property set - stream's contents must be parsed into a {@link - org.apache.poi.hpsf.PropertySet} instance. Its subclasses {@link - org.apache.poi.hpsf.SummaryInformation} and {@link - org.apache.poi.hpsf.DocumentSummaryInformation} deal with the well-known - property set streams \005SummaryInformation and - \005DocumentSummaryInformation. (However, the streams' names are - irrelevant. What counts is the property set's first section's format ID - - see below.)

- -

The factory method {@link org.apache.poi.hpsf.PropertySetFactory#create} - creates a {@link org.apache.poi.hpsf.PropertySet} instance. This method - always returns the most specific property set: If it - identifies the stream data as a Summary Information or as a Document - Summary Information it returns an instance of the corresponding class, else - the general {@link org.apache.poi.hpsf.PropertySet}.

- -

A {@link org.apache.poi.hpsf.PropertySet} contains a list of {@link - org.apache.poi.hpsf.Section}s which can be retrieved with {@link - org.apache.poi.hpsf.PropertySet#getSections}. Each {@link - org.apache.poi.hpsf.Section} contains a {@link - org.apache.poi.hpsf.Property} array which can be retrieved with {@link - org.apache.poi.hpsf.Section#getProperties}. Since the vast majority of - {@link org.apache.poi.hpsf.PropertySet}s contains only a single {@link - org.apache.poi.hpsf.Section}, the convenience method {@link - org.apache.poi.hpsf.PropertySet#getProperties} returns the properties of a - {@link org.apache.poi.hpsf.PropertySet}'s {@link - org.apache.poi.hpsf.Section} (throwing a {@link - org.apache.poi.hpsf.NoSingleSectionException} if the {@link - org.apache.poi.hpsf.PropertySet} contains more (or less) than exactly one - {@link org.apache.poi.hpsf.Section}).

- -

Each {@link org.apache.poi.hpsf.Property} has an ID, a - type, and a value which can be retrieved - with {@link org.apache.poi.hpsf.Property#getID}, {@link - org.apache.poi.hpsf.Property#getType}, and {@link - org.apache.poi.hpsf.Property#getValue}, respectively. The value's class - depends on the property's type. The current implementation - does not yet support all property types and restricts the values' classes - to {@link java.lang.String}, {@link java.lang.Integer} and {@link - java.util.Date}. A value of a yet unknown type is returned as a byte array - containing the value's origin bytes from the property set stream.

- -

To retrieve the value of a specific {@link org.apache.poi.hpsf.Property}, - use {@link org.apache.poi.hpsf.Section#getProperty} or {@link - org.apache.poi.hpsf.Section#getPropertyIntValue}.

- -

The {@link org.apache.poi.hpsf.SummaryInformation} and {@link - org.apache.poi.hpsf.DocumentSummaryInformation} classes provide convenience - methods for retrieving well-known properties. For example, an application - that wants to retrieve a document's title string just calls {@link - org.apache.poi.hpsf.SummaryInformation#getTitle} instead of going through - the hassle of first finding out what the title's property ID is and then - using this ID to get the property's value.

- -

Public documentation from Microsoft can be found in the appropriate section of the MSDN Library.

- -
-

History

- -
-
2003-09-11:
- -
-

{@link org.apache.poi.hpsf.PropertySetFactory#create(InputStream)} no - longer throws an - {@link org.apache.poi.hpsf.UnexpectedPropertySetTypeException}.

-
-
- - -
-

To Do

- -

The following is still left to be implemented. Sponsering could foster - these issues considerably.

- -
    - -
  • -

    Convenience methods for setting summary information and document - summary information properties

    -
    • - -
  • -

    Better codepage support

    -
    • - -
  • -

    Support for more property (variant) types

    -
    • - -
- -
- -

- @author Rainer Klute (klute@rainer-klute.de) -

-
- - - - - diff --git a/src/java/org/apache/poi/hssf/package.html b/src/java/org/apache/poi/hpsf/wellknown/package-info.java similarity index 57% rename from src/java/org/apache/poi/hssf/package.html rename to src/java/org/apache/poi/hpsf/wellknown/package-info.java index b8d8b61326..db9fae9b81 100644 --- a/src/java/org/apache/poi/hssf/package.html +++ b/src/java/org/apache/poi/hpsf/wellknown/package-info.java @@ -1,6 +1,4 @@ - - - - - - +==================================================================== */ -Horrible SpreadSheet Format API's for reading/writting Excel files using pure Java. - -

Related Documentation

- -For overviews, tutorials, examples, guides, and tool documentation, please see: - - - - +/** + * Specific support for DocumentSummaryInformation, SummaryInformation types. + *

+ * Support classes for "well-known" section format IDs and property IDs. The + * streams {@code \005DocumentSummaryInformation} and + * {@code \005SummaryInformation} (or any streams with the same section + * format IDs as the aforementioned) are considered well-known. So are most + * property IDs in these streams. + */ +package org.apache.poi.hpsf.wellknown; \ No newline at end of file diff --git a/src/java/org/apache/poi/hpsf/wellknown/package.html b/src/java/org/apache/poi/hpsf/wellknown/package.html deleted file mode 100644 index 05b4ffb145..0000000000 --- a/src/java/org/apache/poi/hpsf/wellknown/package.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - -

- Specific support for DocumentSummaryInformation, SummaryInformation types. -

Support classes for "well-known" section format IDs and property IDs. The - streams \005DocumentSummaryInformation and - \005SummaryInformation (or any streams with the same section - format IDs as the aforementioned) are considered well-known. So are most - property IDs in these streams.

- -

- @author Rainer Klute (klute@rainer-klute.de) -

-
- - - - - diff --git a/src/examples/src/org/apache/poi/hssf/view/brush/package.html b/src/java/org/apache/poi/hssf/dev/package-info.java similarity index 71% rename from src/examples/src/org/apache/poi/hssf/view/brush/package.html rename to src/java/org/apache/poi/hssf/dev/package-info.java index d9819fb669..74d4c09c9b 100644 --- a/src/examples/src/org/apache/poi/hssf/view/brush/package.html +++ b/src/java/org/apache/poi/hssf/dev/package-info.java @@ -1,6 +1,4 @@ - - - +==================================================================== */ - -This package contains some brushes that are used when drawing borders for Excel -cells. - - +/** + * DEV package serves two purposes: + *
    + *
  1. Examples for how to use HSSF + *
  2. tools for developing and validating HSSF + *
+ */ +package org.apache.poi.hssf.dev; diff --git a/src/java/org/apache/poi/hssf/dev/package.html b/src/java/org/apache/poi/hssf/dev/package.html deleted file mode 100644 index 4d6187b447..0000000000 --- a/src/java/org/apache/poi/hssf/dev/package.html +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - -DEV package serves two purposes. 1. Examples for how to use HSSF and 2. tools for developing -and validating HSSF. - -

Related Documentation

- -For overviews, tutorials, examples, guides, and tool documentation, please see: - - - - diff --git a/src/java/org/apache/poi/hssf/eventusermodel/package-info.java b/src/java/org/apache/poi/hssf/eventusermodel/package-info.java new file mode 100644 index 0000000000..69b02c4daf --- /dev/null +++ b/src/java/org/apache/poi/hssf/eventusermodel/package-info.java @@ -0,0 +1,25 @@ +/* ==================================================================== + 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. +==================================================================== */ + +/** + * HSSF eventmodel Package provides an event-based API for reading HSSF files. + *

+ * The event model can read XLS files with a very small memory footprint. For + * writing you still have to use the usermodel. The eventmodel is to the usermodel + * what SAX is to DOM. + */ +package org.apache.poi.hssf.eventusermodel; diff --git a/src/java/org/apache/poi/hssf/eventusermodel/package.html b/src/java/org/apache/poi/hssf/eventusermodel/package.html deleted file mode 100644 index 0a3b111a48..0000000000 --- a/src/java/org/apache/poi/hssf/eventusermodel/package.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - -HSSF eventmodel Package provides an event-based API for reading HSSF files. - -

Related Documentation

-The event model can reald XLS files with a very small memory footprint. For -writing you still have to use the usermodel. The eventmodel is to the usermodel -what SAX is to DOM. - -For overviews, tutorials, examples, guides, and tool documentation, please see: - - - -@see org.apache.poi.hssf.usermodel -@see org.apache.poi.hssf.record - - diff --git a/src/java/org/apache/poi/hssf/model/package-info.java b/src/java/org/apache/poi/hssf/model/package-info.java new file mode 100644 index 0000000000..b2e8ffcc2d --- /dev/null +++ b/src/java/org/apache/poi/hssf/model/package-info.java @@ -0,0 +1,23 @@ +/* ==================================================================== + 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. +==================================================================== */ + +/** + * Provides low level API structures for reading, writing, modifying XLS files. + * + * @see org.apache.poi.hssf.usermodel + */ +package org.apache.poi.hssf.model; \ No newline at end of file diff --git a/src/java/org/apache/poi/ss/formula/package.html b/src/java/org/apache/poi/hssf/package-info.java similarity index 66% rename from src/java/org/apache/poi/ss/formula/package.html rename to src/java/org/apache/poi/hssf/package-info.java index 3296708d5c..eb95f0d058 100644 --- a/src/java/org/apache/poi/ss/formula/package.html +++ b/src/java/org/apache/poi/hssf/package-info.java @@ -1,6 +1,4 @@ - - - - - - +==================================================================== */ -This package contains common internal POI code for manipulating formulas. -Client applications should not refer to these classes directly. - - - +/** + * Horrible SpreadSheet Format API's for reading/writting Excel files using pure Java. + * + * @see Overview, tutorials, examples, guides, and tool documentation + */ +package org.apache.poi.hssf; diff --git a/src/java/org/apache/poi/ddf/package.html b/src/java/org/apache/poi/hssf/record/aggregates/package-info.java similarity index 63% rename from src/java/org/apache/poi/ddf/package.html rename to src/java/org/apache/poi/hssf/record/aggregates/package-info.java index 6a3393d63d..79c1fbcb3a 100644 --- a/src/java/org/apache/poi/ddf/package.html +++ b/src/java/org/apache/poi/hssf/record/aggregates/package-info.java @@ -1,6 +1,4 @@ - - - - +==================================================================== */ -

This package contains classes for decoding the Microsoft Office - Drawing format otherwise known as escher henceforth known in POI - as the Dreadful Drawing Format. -

- - - +/** + * The record aggregates are not real "records" but collections of records that act as a single record. + * This is an optimization basically. + * + * @see org.apache.poi.hssf.record + * @see org.apache.poi.hssf.eventmodel + * @see org.apache.poi.hssf.record.RecordFactory + */ +package org.apache.poi.hssf.record.aggregates; \ No newline at end of file diff --git a/src/java/org/apache/poi/hssf/record/aggregates/package.html b/src/java/org/apache/poi/hssf/record/aggregates/package.html deleted file mode 100644 index ccf7a60973..0000000000 --- a/src/java/org/apache/poi/hssf/record/aggregates/package.html +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - -record aggregates are not real "records" but collections of records that act as a single record. -This is an optimization basically. - -

Related Documentation

- -For overviews, tutorials, examples, guides, and tool documentation, please see: - - - -@see org.apache.poi.hssf.record -@see org.apache.poi.hssf.eventmodel -@see org.apache.poi.hssf.record.RecordFactory - - diff --git a/src/examples/src/org/apache/poi/ss/examples/html/package.html b/src/java/org/apache/poi/hssf/record/package-info.java similarity index 69% rename from src/examples/src/org/apache/poi/ss/examples/html/package.html rename to src/java/org/apache/poi/hssf/record/package-info.java index 1c8e6af5c4..9d47affa70 100644 --- a/src/examples/src/org/apache/poi/ss/examples/html/package.html +++ b/src/java/org/apache/poi/hssf/record/package-info.java @@ -1,6 +1,4 @@ - - - - - - -This package contains an example that uses POI to convert a workbook into -an HTML representation of the data. It can use both XSSF and HSSF workbooks. - - +==================================================================== */ + +/** + * Record package contains class representations for XLS binary strutures. Its very low level. + * + * @see org.apache.poi.hssf.eventmodel + * @see org.apache.poi.hssf.record.RecordFactory + */ +package org.apache.poi.hssf.record; \ No newline at end of file diff --git a/src/java/org/apache/poi/hssf/record/package.html b/src/java/org/apache/poi/hssf/record/package.html deleted file mode 100644 index 446535891e..0000000000 --- a/src/java/org/apache/poi/hssf/record/package.html +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - -Record package contains class representations for XLS binary strutures. Its very -low level. - -

Related Documentation

- -For overviews, tutorials, examples, guides, and tool documentation, please see: - - - -@see org.apache.poi.hssf.eventmodel -@see org.apache.poi.hssf.record.RecordFactory - - diff --git a/src/java/org/apache/poi/hssf/usermodel/package-info.java b/src/java/org/apache/poi/hssf/usermodel/package-info.java new file mode 100644 index 0000000000..7fe4e03ee3 --- /dev/null +++ b/src/java/org/apache/poi/hssf/usermodel/package-info.java @@ -0,0 +1,21 @@ +/* ==================================================================== + 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. +==================================================================== */ + +/** + * The usermodel package maps HSSF low level structures to familiar workbook/sheet model + */ +package org.apache.poi.hssf.usermodel; diff --git a/src/java/org/apache/poi/hssf/usermodel/package.html b/src/java/org/apache/poi/hssf/usermodel/package.html deleted file mode 100644 index 5779057bfe..0000000000 --- a/src/java/org/apache/poi/hssf/usermodel/package.html +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - -usermodel package maps HSSF low level strutures to familiar workbook/sheet model - -

Related Documentation

- -For overviews, tutorials, examples, guides, and tool documentation, please see: - - - - diff --git a/src/java/org/apache/poi/hssf/util/package-info.java b/src/java/org/apache/poi/hssf/util/package-info.java new file mode 100644 index 0000000000..4ac9c8f6f6 --- /dev/null +++ b/src/java/org/apache/poi/hssf/util/package-info.java @@ -0,0 +1,21 @@ +/* ==================================================================== + 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. +==================================================================== */ + +/** + * The util package contains tools needed for writing HSSF files that are not necesarily "real" HSSF concepts. + */ +package org.apache.poi.hssf.util; diff --git a/src/java/org/apache/poi/hssf/util/package.html b/src/java/org/apache/poi/hssf/util/package.html deleted file mode 100644 index 7936e88f23..0000000000 --- a/src/java/org/apache/poi/hssf/util/package.html +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - -util package contains tools needed for writing HSSF files that are not necesarily "real" -HSSF concepts. - -

Related Documentation

- -For overviews, tutorials, examples, guides, and tool documentation, please see: - - - - diff --git a/src/java/org/apache/poi/ss/format/package-info.java b/src/java/org/apache/poi/ss/format/package-info.java new file mode 100644 index 0000000000..71f14cb2b3 --- /dev/null +++ b/src/java/org/apache/poi/ss/format/package-info.java @@ -0,0 +1,21 @@ +/* ==================================================================== + 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. +==================================================================== */ + +/** + * This package contains classes that implement cell formatting + */ +package org.apache.poi.ss.format; diff --git a/src/java/org/apache/poi/ss/formula/package-info.java b/src/java/org/apache/poi/ss/formula/package-info.java new file mode 100644 index 0000000000..68eb7e42f2 --- /dev/null +++ b/src/java/org/apache/poi/ss/formula/package-info.java @@ -0,0 +1,22 @@ +/* ==================================================================== + 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. +==================================================================== */ + +/** + * This package contains common internal POI code for manipulating formulas. + * Client applications should not refer to these classes directly. + */ +package org.apache.poi.ss.formula; \ No newline at end of file diff --git a/src/java/org/apache/poi/ss/formula/ptg/package-info.java b/src/java/org/apache/poi/ss/formula/ptg/package-info.java new file mode 100644 index 0000000000..e2e6da8b03 --- /dev/null +++ b/src/java/org/apache/poi/ss/formula/ptg/package-info.java @@ -0,0 +1,24 @@ +/* ==================================================================== + 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. +==================================================================== */ + +/** + * The formula package contains binary PTG structures used in Formulas + * + * @see org.apache.poi.hssf.record + * @see org.apache.poi.hssf.record.FormulaRecord + */ +package org.apache.poi.ss.formula.ptg; \ No newline at end of file diff --git a/src/java/org/apache/poi/ss/formula/ptg/package.html b/src/java/org/apache/poi/ss/formula/ptg/package.html deleted file mode 100644 index b0e899c1ba..0000000000 --- a/src/java/org/apache/poi/ss/formula/ptg/package.html +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - - -formula package contains binary PTG structures used in Formulas - -

Related Documentation

- -For overviews, tutorials, examples, guides, and tool documentation, please see: - - - -@see org.apache.poi.hssf.record -@see org.apache.poi.hssf.record.FormulaRecord - - diff --git a/src/java/org/apache/poi/util/package-info.java b/src/java/org/apache/poi/util/package-info.java new file mode 100644 index 0000000000..268d5b83ee --- /dev/null +++ b/src/java/org/apache/poi/util/package-info.java @@ -0,0 +1,22 @@ +/* ==================================================================== + 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. +==================================================================== */ + +/** + * Top-level util package are classes that are useful throughout the project. These classes are + * generally generic enough to be useful in any project and should be contributed elsewhere! + */ +package org.apache.poi.util; diff --git a/src/java/org/apache/poi/util/package.html b/src/java/org/apache/poi/util/package.html deleted file mode 100644 index c8eeaab894..0000000000 --- a/src/java/org/apache/poi/util/package.html +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - -Top-level util package are classes that are useful throughout the project. These classes are -generally generic enough to be useful in any project and should be contributed elsewhere! - -

Related Documentation

- -For overviews, tutorials, examples, guides, and tool documentation, please see: - - - - diff --git a/src/java/org/apache/poi/hssf/model/package.html b/src/ooxml/java/org/apache/poi/xssf/binary/package-info.java similarity index 55% rename from src/java/org/apache/poi/hssf/model/package.html rename to src/ooxml/java/org/apache/poi/xssf/binary/package-info.java index 2833d70a6b..7efaeaae7b 100644 --- a/src/java/org/apache/poi/hssf/model/package.html +++ b/src/ooxml/java/org/apache/poi/xssf/binary/package-info.java @@ -1,6 +1,4 @@ - - - - - - +==================================================================== */ -Provides low level API structures for reading, writing, modifying XLS files. - -

Related Documentation

- -For overviews, tutorials, examples, guides, and tool documentation, please see: - - - -@see org.apache.poi.hssf.usermodel - - - +/** + * The org.apache.poi.xssf.binary package includes necessary underlying components + * for streaming/read-only processing of xlsb files. + *

+ * POI does not yet support opening .xlsb files with XSSFWorkbook, but you can read files with XSSFBReader + * in org.apache.poi.xssf.eventusermodel. + *

+ * This feature was added in poi-3.16-beta3 and should be considered experimental. + * Most classes have been marked @Internal and the API is subject to change. + */ +package org.apache.poi.xssf.binary; diff --git a/src/ooxml/java/org/apache/poi/xssf/binary/package.html b/src/ooxml/java/org/apache/poi/xssf/binary/package.html deleted file mode 100644 index 21a30e1df9..0000000000 --- a/src/ooxml/java/org/apache/poi/xssf/binary/package.html +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - -

The org.apache.poi.xssf.binary package includes necessary underlying components -for streaming/read-only processing of xlsb files. -

-

- POI does not yet support opening .xlsb files with XSSFWorkbook, but you can read files with XSSFBReader - in org.apache.poi.xssf.eventusermodel. -

-

- This feature was added in poi-3.16-beta3 and should be considered experimental. Most classes - have been marked @Internal and the API is subject to change. -

-

Related Documentation

- -For overviews, tutorials, examples, guides, and tool documentation, please see: - - - - diff --git a/src/ooxml/java/org/apache/poi/xwpf/package-info.java b/src/ooxml/java/org/apache/poi/xwpf/package-info.java new file mode 100644 index 0000000000..0d425b0979 --- /dev/null +++ b/src/ooxml/java/org/apache/poi/xwpf/package-info.java @@ -0,0 +1,22 @@ +/* ==================================================================== + 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. +==================================================================== */ + +/** + * This package contains classes for handling Microsoft .docx Word Processing files, known in POI as + * XWPF (XML Word Processing Format). + */ +package org.apache.poi.xwpf; \ No newline at end of file