added an annotation '@Internal' to mark program elements intended for POI internal...

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@886846 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/poi/util/Internal.java b/src/java/org/apache/poi/util/Internal.java
new file mode 100644 (file)
index 0000000..e510df1
--- /dev/null
+++ b/src/java/org/apache/poi/util/Internal.java
@@ -0,0 +1,37 @@
+/*\r
+ * Licensed to the Apache Software Foundation (ASF) under one or more\r
+ * contributor license agreements.  See the NOTICE file distributed with\r
+ * this work for additional information regarding copyright ownership.\r
+ * The ASF licenses this file to You under the Apache License, Version 2.0\r
+ * (the "License"); you may not use this file except in compliance with\r
+ * the License.  You may obtain a copy of the License at\r
+ *\r
+ *     http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ */\r
+package org.apache.poi.util;\r
+\r
+import java.lang.annotation.RetentionPolicy;\r
+import java.lang.annotation.Retention;\r
+import java.lang.annotation.Documented;\r
+\r
+\r
+/**\r
+ * Program elements annotated @Internal are intended for\r
+ * POI internal use only. Such elements are not public by design\r
+ * and likely to be removed in future versions of POI  or access\r
+ * to such elements will be changed from 'public' to 'default' or less.\r
+ *\r
+ * @author Yegor Kozlov\r
+ * @since POI-3.6\r
+ */\r
+@Documented\r
+@Retention(RetentionPolicy.SOURCE)\r
+public @interface Internal {\r
+\r
+}\r

diff --git a/src/ooxml/java/org/apache/poi/xslf/XSLFSlideShow.java b/src/ooxml/java/org/apache/poi/xslf/XSLFSlideShow.java
index 57b801d9424934759e51463ac059d56feefd18ea..be8615cd9bedf9493e06466af1e3b2cc7b949d4e 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xslf/XSLFSlideShow.java
+++ b/src/ooxml/java/org/apache/poi/xslf/XSLFSlideShow.java
@@ -21,6 +21,7 @@ import java.util.LinkedList;
 import java.util.List;
 
 import org.apache.poi.POIXMLDocument;
+import org.apache.poi.util.Internal;
 import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
 import org.apache.poi.openxml4j.exceptions.OpenXML4JException;
 import org.apache.poi.openxml4j.opc.OPCPackage;
@@ -93,6 +94,7 @@ public class XSLFSlideShow extends POIXMLDocument {
        /**
         * Returns the low level presentation base object
         */
+    @Internal
        public CTPresentation getPresentation() {
                return presentationDoc.getPresentation();
        }
@@ -103,6 +105,7 @@ public class XSLFSlideShow extends POIXMLDocument {
         * You'll need these to figure out the slide ordering,
         *  and to get at the actual slides themselves
         */
+    @Internal
        public CTSlideIdList getSlideReferences() {
                return getPresentation().getSldIdLst();
        }
@@ -112,6 +115,7 @@ public class XSLFSlideShow extends POIXMLDocument {
         * You'll need these to get at the actual slide 
         *  masters themselves
         */
+    @Internal
        public CTSlideMasterIdList getSlideMasterReferences() {
                return getPresentation().getSldMasterIdLst();
        }
@@ -129,6 +133,7 @@ public class XSLFSlideShow extends POIXMLDocument {
         * Returns the low level slide master object from
         *  the supplied slide master reference
         */
+    @Internal
        public CTSlideMaster getSlideMaster(CTSlideMasterIdListEntry master) throws IOException, XmlException {
                PackagePart masterPart = getSlideMasterPart(master);
                SldMasterDocument masterDoc =
@@ -149,6 +154,7 @@ public class XSLFSlideShow extends POIXMLDocument {
         * Returns the low level slide object from
         *  the supplied slide reference
         */
+    @Internal
        public CTSlide getSlide(CTSlideIdListEntry slide) throws IOException, XmlException {
                PackagePart slidePart = getSlidePart(slide);
                SldDocument slideDoc =
@@ -188,6 +194,7 @@ public class XSLFSlideShow extends POIXMLDocument {
         * Returns the low level notes object for the given
         *  slide, as found from the supplied slide reference
         */
+    @Internal
        public CTNotesSlide getNotes(CTSlideIdListEntry slide) throws IOException, XmlException {
                PackagePart notesPart = getNodesPart(slide);
                if(notesPart == null)
@@ -202,6 +209,7 @@ public class XSLFSlideShow extends POIXMLDocument {
        /**
         * Returns all the comments for the given slide
         */
+    @Internal
        public CTCommentList getSlideComments(CTSlideIdListEntry slide) throws IOException, XmlException {
                PackageRelationshipCollection commentRels;
                PackagePart slidePart = getSlidePart(slide);

diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFSlide.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFSlide.java
index e4e96e6d51a782dfcf0eee83014b6a3b312d1866..90de6e8a0d6b25507129a91fd10569d02cf4d710 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFSlide.java
+++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFSlide.java
@@ -19,6 +19,7 @@ package org.apache.poi.xslf.usermodel;
 import org.apache.poi.sl.usermodel.Notes;
 import org.apache.poi.sl.usermodel.Slide;
 import org.apache.poi.sl.usermodel.SlideShow;
+import org.apache.poi.util.Internal;
 import org.openxmlformats.schemas.presentationml.x2006.main.CTSlide;
 import org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry;
 
@@ -35,12 +36,14 @@ public class XSLFSlide extends XSLFSheet implements Slide {
        /**
         * While developing only!
         */
+    @Internal
        public CTSlide _getCTSlide() {
                return slide;
        }
        /**
         * While developing only!
         */
+    @Internal
        public CTSlideIdListEntry _getCTSlideId() {
                return slideId;
        }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java
index 2ad093e29218c58e67df67bf9badd7dea9a0b588..a3cc23a79513cd2c559234802ce0e269a8119bed 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java
@@ -40,6 +40,7 @@ import org.apache.poi.ss.usermodel.RichTextString;
 import org.apache.poi.ss.util.CellReference;
 import org.apache.poi.xssf.model.SharedStringsTable;
 import org.apache.poi.xssf.model.StylesTable;
+import org.apache.poi.util.Internal;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCell;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCellFormula;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.STCellFormulaType;
@@ -851,6 +852,7 @@ public final class XSSFCell implements Cell {
      *
      * @return the xml bean containing information about this cell
      */
+    @Internal
     public CTCell getCTCell(){
         return _cell;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java
index 4dea4de5e40edf064881b178df1b948a2dd9241f..00dc1c4a5d7a6dfe710313f123f03487fc2babcf 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java
@@ -29,6 +29,7 @@ import org.apache.poi.xssf.usermodel.extensions.XSSFCellAlignment;
 import org.apache.poi.xssf.usermodel.extensions.XSSFCellBorder;
 import org.apache.poi.xssf.usermodel.extensions.XSSFCellFill;
 import org.apache.poi.xssf.usermodel.extensions.XSSFCellBorder.BorderSide;
+import org.apache.poi.util.Internal;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorder;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorderPr;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCellAlignment;
@@ -74,6 +75,7 @@ public class XSSFCellStyle implements CellStyle {
     /**
      * Used so that StylesSource can figure out our location
      */
+    @Internal
     public CTXf getCoreXf() {
         return _cellXf;
     }
@@ -81,6 +83,7 @@ public class XSSFCellStyle implements CellStyle {
     /**
      * Used so that StylesSource can figure out our location
      */
+    @Internal
     public CTXf getStyleXf() {
         return _cellStyleXf;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFChildAnchor.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFChildAnchor.java
index 5032395394129e8fea084fa57f8532f0903c0ebf..4dc3db8c4878a478ef659dfcacf96c9a0239eb3b 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFChildAnchor.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFChildAnchor.java
@@ -20,6 +20,7 @@ package org.apache.poi.xssf.usermodel;
 import org.openxmlformats.schemas.drawingml.x2006.main.CTPoint2D;
 import org.openxmlformats.schemas.drawingml.x2006.main.CTPositiveSize2D;
 import org.openxmlformats.schemas.drawingml.x2006.main.CTTransform2D;
+import org.apache.poi.util.Internal;
 
 /**
  * @author Yegor Kozlov
@@ -44,6 +45,7 @@ public final class XSSFChildAnchor extends XSSFAnchor {
         this.t2d = t2d;
     }
 
+    @Internal
     public CTTransform2D getCTTransform2D() {
         return t2d;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFClientAnchor.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFClientAnchor.java
index 28efca9def86c02e55a8b03f071471d3f24b5195..76990c017396d1a6e5b62d945b83d8a25e828bc4 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFClientAnchor.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFClientAnchor.java
@@ -18,6 +18,7 @@
 package org.apache.poi.xssf.usermodel;
 
 import org.apache.poi.ss.usermodel.ClientAnchor;
+import org.apache.poi.util.Internal;
 import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker;
 
 /**
@@ -175,6 +176,7 @@ public final class XSSFClientAnchor extends XSSFAnchor implements ClientAnchor {
      *
      * @return starting anchor point
      */
+    @Internal
     public CTMarker getFrom(){
         return cell1;
     }
@@ -188,6 +190,7 @@ public final class XSSFClientAnchor extends XSSFAnchor implements ClientAnchor {
      *
      * @return ending anchor point
      */
+    @Internal
     public CTMarker getTo(){
         return cell2;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFColor.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFColor.java
index 4a2c63f03bef4af3b3f9ed384fdadd5388045cc4..6c63195d40dc02dfdaf481c6bd3b1f9737c42fa3 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFColor.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFColor.java
@@ -17,6 +17,7 @@
 package org.apache.poi.xssf.usermodel;
 
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor;
+import org.apache.poi.util.Internal;
 
 /**
  * Represents a color in SpreadsheetML
@@ -197,6 +198,7 @@ public class XSSFColor {
      *
      * @return the underlying XML bean
      */
+    @Internal
     public CTColor getCTColor(){
         return ctColor;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFConnector.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFConnector.java
index a5d2262c9ce62628bcb9e8f3899bb3aef7307985..7dab16c7115f01e5953245f0f5b4e5dcdb684ee8 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFConnector.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFConnector.java
@@ -32,6 +32,7 @@ import org.openxmlformats.schemas.drawingml.x2006.main.STSchemeColorVal;
 import org.openxmlformats.schemas.drawingml.x2006.main.STShapeType;
 import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTConnector;
 import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTConnectorNonVisual;
+import org.apache.poi.util.Internal;
 
 /**
  * A connection shape drawing element. A connection shape is a line, etc.
@@ -104,6 +105,7 @@ public final class XSSFConnector extends XSSFShape {
         return prototype;
     }
 
+    @Internal
     public CTConnector getCTConnector(){
         return ctShape;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFDrawing.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFDrawing.java
index a2a651f97d1a1ecd41d7cfdb08cbb8b7b0fe8769..ae5410cc69df0aaac867826ccd29b0d53386cc0d 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFDrawing.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFDrawing.java
@@ -25,6 +25,7 @@ import java.util.Map;
 import javax.xml.namespace.QName;
 
 import org.apache.poi.POIXMLDocumentPart;
+import org.apache.poi.util.Internal;
 import org.apache.poi.xssf.model.CommentsTable;
 import org.apache.poi.openxml4j.opc.PackagePart;
 import org.apache.poi.openxml4j.opc.PackagePartName;
@@ -93,6 +94,7 @@ public final class XSSFDrawing extends POIXMLDocumentPart implements Drawing {
      *
      * @return the underlying CTDrawing bean
      */
+    @Internal
     public CTDrawing getCTDrawing(){
         return drawing;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java
index 8281ac3b11c92df02332b498b7cbc9fe9564bb5a..7fbbee79516c1fe3fc192fcbe8d83cc77869fd05 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java
@@ -17,6 +17,7 @@
 package org.apache.poi.xssf.usermodel;
 
 import org.apache.poi.POIXMLException;
+import org.apache.poi.util.Internal;
 import org.apache.poi.ss.usermodel.Font;
 import org.apache.poi.ss.usermodel.FontCharset;
 import org.apache.poi.ss.usermodel.FontFamily;
@@ -88,6 +89,7 @@ public class XSSFFont implements Font {
     /**
      * get the underlying CTFont font
      */
+    @Internal
     public CTFont getCTFont() {
         return _ctFont;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFMap.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFMap.java
index 33c742f6e73f41009fd551ca78cd1feb0605f2db..6d40b686ad15867d87cef264e333a7ca495da1be 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFMap.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFMap.java
@@ -21,6 +21,7 @@ import java.util.List;
 import java.util.Vector;
 
 import org.apache.poi.POIXMLDocumentPart;
+import org.apache.poi.util.Internal;
 import org.apache.poi.xssf.model.MapInfo;
 import org.apache.poi.xssf.model.SingleXmlCells;
 import org.apache.poi.xssf.model.Table;
@@ -53,11 +54,13 @@ public class XSSFMap {
     }
 
 
+    @Internal
     public CTMap getCtMap() {
         return ctMap;
     }
 
 
+    @Internal
     public CTSchema getCTSchema() {
         String schemaId = ctMap.getSchemaID();
         return mapInfo.getCTSchemaById(schemaId);

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java
index 0a0fdf086b8de0f698127142bf607b5f3f03a7d5..12f6b064de688961d9c5bb1c321c7bba099bce30 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java
@@ -34,6 +34,7 @@ import org.apache.poi.ss.usermodel.Workbook;
 import org.apache.poi.ss.util.ImageUtils;
 import org.apache.poi.util.POILogFactory;
 import org.apache.poi.util.POILogger;
+import org.apache.poi.util.Internal;
 import org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties;
 import org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualDrawingProps;
 import org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualPictureProperties;
@@ -141,6 +142,7 @@ public final class XSSFPicture extends XSSFShape implements Picture {
      *
      * @return the underlying CTPicture bean
      */
+    @Internal
     public CTPicture getCTPicture(){
         return ctPicture;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRichTextString.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRichTextString.java
index 8775a9c11ea76b0f6dfc81402b30e1fc2755083e..90b04a1d3a368d3a73dce370d4d8ab8f66828392 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRichTextString.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRichTextString.java
@@ -24,6 +24,7 @@ import javax.xml.namespace.QName;
 import org.apache.poi.ss.usermodel.Font;
 import org.apache.poi.ss.usermodel.RichTextString;
 import org.apache.poi.xssf.model.StylesTable;
+import org.apache.poi.util.Internal;
 import org.apache.xmlbeans.XmlCursor;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTFont;
@@ -416,6 +417,7 @@ public class XSSFRichTextString implements RichTextString {
     /**
      * Return the underlying xml bean
      */
+    @Internal
     public CTRst getCTRst() {
         return st;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java
index 91bb3e4c8d5f145bb79965a85d5ddfc9412b4870..9e564023e9887e8a004197df6ae4421a444873cf 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java
@@ -27,6 +27,7 @@ import org.apache.poi.ss.usermodel.Row;
 import org.apache.poi.ss.util.CellReference;
 import org.apache.poi.util.POILogFactory;
 import org.apache.poi.util.POILogger;
+import org.apache.poi.util.Internal;
 import org.apache.poi.xssf.model.CalculationChain;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCell;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRow;
@@ -368,6 +369,7 @@ public class XSSFRow implements Row, Comparable<XSSFRow> {
      *
      * @return the underlying CTRow xml bean
      */
+    @Internal
     public CTRow getCTRow(){
        return _row;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFShapeGroup.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFShapeGroup.java
index ce691561e54ea4150979e010e2ba0d4170e8c3b8..b625134a7cd40aa14bfb2056ddf12df366dbad6f 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFShapeGroup.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFShapeGroup.java
@@ -18,6 +18,7 @@
 package org.apache.poi.xssf.usermodel;
 
 import org.apache.poi.openxml4j.opc.PackageRelationship;
+import org.apache.poi.util.Internal;
 import org.openxmlformats.schemas.drawingml.x2006.main.CTGroupShapeProperties;
 import org.openxmlformats.schemas.drawingml.x2006.main.CTGroupTransform2D;
 import org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualDrawingProps;
@@ -163,6 +164,7 @@ public final class XSSFShapeGroup extends XSSFShape {
         return shape;
     }
 
+    @Internal
     public CTGroupShape getCTGroupShape() {
         return ctGroup;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
index 318f2f6ddb62c16d68b1cdfc8c296498da0d55bf..a9b0c145bfb652a4abb6c0210245e67b2f85f118 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
@@ -49,6 +49,7 @@ import org.apache.poi.ss.util.CellRangeAddress;
 import org.apache.poi.ss.util.CellReference;
 import org.apache.poi.util.POILogFactory;
 import org.apache.poi.util.POILogger;
+import org.apache.poi.util.Internal;
 import org.apache.poi.xssf.model.CommentsTable;
 import org.apache.poi.xssf.usermodel.helpers.ColumnHelper;
 import org.apache.poi.xssf.usermodel.helpers.XSSFRowShifter;
@@ -218,6 +219,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet {
      *
      * @return the CTWorksheet bean holding this sheet's data
      */
+    @Internal
     public CTWorksheet getCTWorksheet() {
         return this.worksheet;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java
index 7fc27de89df14aec342ba698b167cfb2ab9119f2..7900d8452e2bf344c08c701578ef15b9946e07f6 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java
@@ -42,6 +42,7 @@ import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShape;
 import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShapeNonVisual;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRElt;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRPrElt;
+import org.apache.poi.util.Internal;
 
 /**
  * Represents a shape with a predefined geometry in a SpreadsheetML drawing.
@@ -126,6 +127,7 @@ public class XSSFSimpleShape extends XSSFShape { // TODO - instantiable supercla
         return prototype;
     }
 
+    @Internal
     public CTShape getCTShape(){
         return ctShape;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
index 9af7515af9f20a14d7d5bd8d4f8f89fd3a1af292..fc7fec62851f35ffb8b743de144d5572cc6097b7 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
@@ -51,10 +51,7 @@ import org.apache.poi.ss.usermodel.Sheet;
 import org.apache.poi.ss.usermodel.Workbook;
 import org.apache.poi.ss.usermodel.Row.MissingCellPolicy;
 import org.apache.poi.ss.util.CellReference;
-import org.apache.poi.util.IOUtils;
-import org.apache.poi.util.POILogFactory;
-import org.apache.poi.util.POILogger;
-import org.apache.poi.util.PackageHelper;
+import org.apache.poi.util.*;
 import org.apache.poi.xssf.model.CalculationChain;
 import org.apache.poi.xssf.model.MapInfo;
 import org.apache.poi.xssf.model.SharedStringsTable;
@@ -290,6 +287,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable<X
      *
      * @return the underlying CTWorkbook bean
      */
+    @Internal
     public CTWorkbook getCTWorkbook() {
         return this.workbook;
     }
@@ -1180,6 +1178,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable<X
      *
      * @return the shared string table
      */
+    @Internal
     public SharedStringsTable getSharedStringSource() {
         return this.sharedStringSource;
     }
@@ -1351,6 +1350,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable<X
      *
      * @return the <code>CalculationChain</code> object or <code>null</code> if not defined
      */
+    @Internal
     public CalculationChain getCalculationChain(){
         return calcChain;
     }
@@ -1367,6 +1367,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable<X
      *
      * @return the helper class used to query the custom XML mapping defined in this workbook
      */
+    @Internal
     public MapInfo getMapInfo(){
        return mapInfo;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellAlignment.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellAlignment.java
index 6c9600806cbca3091a88e7114ff4f8916db705b3..ccc1b30a4fd02af8b0cba6bb4164ebfe8fbf8317 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellAlignment.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellAlignment.java
@@ -21,6 +21,7 @@ import org.openxmlformats.schemas.spreadsheetml.x2006.main.STHorizontalAlignment
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.STVerticalAlignment;
 import org.apache.poi.ss.usermodel.HorizontalAlignment;
 import org.apache.poi.ss.usermodel.VerticalAlignment;
+import org.apache.poi.util.Internal;
 
 
 /**
@@ -160,6 +161,7 @@ public class XSSFCellAlignment {
     /**
      * Access to low-level data
      */
+    @Internal
     public CTCellAlignment getCTCellAlignment() {
         return cellAlignement;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellBorder.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellBorder.java
index 91cd0ab27c5a2bad4227bfa7f1e560009e9dbacc..54d584bc6a5d6510a98a63daf6346f29b0d04717 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellBorder.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellBorder.java
@@ -19,6 +19,7 @@ package org.apache.poi.xssf.usermodel.extensions;
 
 import org.apache.poi.ss.usermodel.BorderStyle;
 import org.apache.poi.xssf.usermodel.XSSFColor;
+import org.apache.poi.util.Internal;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorder;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorderPr;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.STBorderStyle;
@@ -59,6 +60,7 @@ public class XSSFCellBorder {
      *
      * @return CTBorder
      */
+    @Internal
     public CTBorder getCTBorder() {
         return border;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellFill.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellFill.java
index e9d383442511cd2dde5aac13742a2aa4d431234c..fd6a70ef42aef60238a762d556e47d8f8057a5de 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellFill.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellFill.java
@@ -21,6 +21,7 @@ import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTFill;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPatternFill;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.STPatternType;
 import org.apache.poi.xssf.usermodel.XSSFColor;
+import org.apache.poi.util.Internal;
 
 /**
  * This element specifies fill formatting.
@@ -147,6 +148,7 @@ public final class XSSFCellFill {
      *
      * @return CTFill
      */
+    @Internal
     public CTFill getCTFill() {
         return _fill;
     }

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFHeaderFooter.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFHeaderFooter.java
index 9bf8243dd27b307e8e8848d4881041e734f93390..62267f2c79b8b545340fca2aeb2e127dece4d695 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFHeaderFooter.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFHeaderFooter.java
@@ -19,6 +19,7 @@ package org.apache.poi.xssf.usermodel.extensions;
 
 import org.apache.poi.ss.usermodel.HeaderFooter;
 import org.apache.poi.xssf.usermodel.helpers.HeaderFooterHelper;
+import org.apache.poi.util.Internal;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHeaderFooter;
 
 /**
@@ -140,6 +141,7 @@ public abstract class XSSFHeaderFooter implements HeaderFooter {
         *
         * @return the underlying CTHeaderFooter xml bean
         */
+    @Internal
        public CTHeaderFooter getHeaderFooter() {
                return this.headerFooter;
        }

diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/TOC.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/TOC.java
index 5f44cc638154f8e4f4cec1a378eaeee5c0ff2e76..3258a9f4d2347c7d9d34cca723f88a435dce6b6e 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/TOC.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/TOC.java
@@ -1,8 +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.
+==================================================================== */
 package org.apache.poi.xwpf.usermodel;
 
 import java.math.BigInteger;
 
 import org.apache.xmlbeans.impl.xb.xmlschema.SpaceAttribute.Space;
+import org.apache.poi.util.Internal;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDecimalNumber;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFonts;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
@@ -56,7 +73,8 @@ public class TOC {
                p.addNewR().addNewT().set("Table of Contents");
        }
 
-       public CTSdtBlock getBlock() {
+    @Internal
+    public CTSdtBlock getBlock() {
                return this.block;
        }
 

diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
index 38e209a5030725d7c3665199582adeae7595c209..640833c12cddddd1ce8a6d949a884629f079d3bf 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
@@ -43,6 +43,7 @@ import org.apache.poi.openxml4j.opc.PackageRelationshipTypes;
 import org.apache.poi.openxml4j.opc.PackagingURIHelper;
 import org.apache.poi.openxml4j.opc.TargetMode;
 import org.apache.poi.util.PackageHelper;
+import org.apache.poi.util.Internal;
 import org.apache.poi.xwpf.model.XWPFHeaderFooterPolicy;
 import org.apache.xmlbeans.XmlException;
 import org.apache.xmlbeans.XmlOptions;
@@ -231,6 +232,7 @@ public class XWPFDocument extends POIXMLDocument {
     /**
      * Returns the low level document base object
      */
+    @Internal
     public CTDocument1 getDocument() {
         return ctDocument;
     }
@@ -321,6 +323,7 @@ public class XWPFDocument extends POIXMLDocument {
     /**
      * Returns the styles object used
      */
+    @Internal
     public CTStyles getStyle() throws XmlException, IOException {
         PackagePart[] parts;
         try {

diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java
index 1481697d0945152d03085ec73a0bff31fbf309dd..367242ee5c506dd6e85ce69946b3637b5daa7bbd 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java
@@ -19,6 +19,7 @@ package org.apache.poi.xwpf.usermodel;
 import java.io.IOException;
 
 import org.apache.poi.POIXMLDocumentPart;
+import org.apache.poi.util.Internal;
 import org.apache.poi.openxml4j.opc.PackagePart;
 import org.apache.poi.openxml4j.opc.PackageRelationship;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr;
@@ -40,6 +41,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart{
                super(part, rel);
        }
        
+    @Internal
        public CTHdrFtr _getHdrFtr() {
                return headerFooter;
        }

diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java
index d4bdfcd0ac3309c1ee520e8a980ff38f1faae33f..3bdf4c365ebe3e82002bf10473684e63c1e614c5 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java
@@ -22,6 +22,7 @@ import java.util.Arrays;
 
 import org.apache.xmlbeans.XmlCursor;
 import org.apache.xmlbeans.XmlObject;
+import org.apache.poi.util.Internal;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTBorder;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdnRef;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTInd;
@@ -149,6 +150,7 @@ public class XWPFParagraph {
         }
     }
 
+    @Internal
     public CTP getCTP() {
         return paragraph;
     }

diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
index e1940bd1f9d168cbfd1584235034ff9395cca16c..93dd9c8f161fb92cc32515fef5d6ccfc879437b7 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
@@ -33,6 +33,7 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.STBrType;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.STOnOff;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.STUnderline;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.STVerticalAlignRun;
+import org.apache.poi.util.Internal;
 
 /**
  * XWPFRun object defines a region of text with a common set of properties
@@ -56,6 +57,7 @@ public class XWPFRun {
      * Get the currently used CTR object
      * @return ctr object
      */
+    @Internal
     public CTR getCTR() {
         return run;
     }

diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTable.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTable.java
index 774cf852c1a21b84f87d79c1dca26075d31f4a73..61a1f11fd0f8ff56b3b8a0ccaefc6fba00018642 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTable.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTable.java
@@ -27,6 +27,7 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblWidth;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.STBorder;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.STTblWidth;
+import org.apache.poi.util.Internal;
 
 /**
  * Sketch of XWPFTable class. Only table's text is being hold.
@@ -109,6 +110,7 @@ public class XWPFTable {
     /**
      * @return ctTbl object
      */
+    @Internal
     public CTTbl getCTTbl() {
         return ctTbl;
     }

diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTableCell.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTableCell.java
index 4a93c98388a05b76136b01dc32e792ce2efc5dfe..7d56df42e3427f6944f96f0a46b7e813bd4f5274 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTableCell.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTableCell.java
@@ -18,6 +18,7 @@ package org.apache.poi.xwpf.usermodel;
 
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc;
+import org.apache.poi.util.Internal;
 
 
 public class XWPFTableCell {
@@ -34,6 +35,7 @@ public class XWPFTableCell {
     }
 
 
+    @Internal
     public CTTc getCTTc() {
         return ctTc;
     }

diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTableRow.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTableRow.java
index 9893d615efaa70635e3fa4e7444f66a33fa267f6..6794808efd6960310fdce16794957a6e586fd3ba 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTableRow.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTableRow.java
@@ -21,6 +21,7 @@ import java.math.BigInteger;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHeight;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRow;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTrPr;
+import org.apache.poi.util.Internal;
 
 
 /**
@@ -34,6 +35,7 @@ public class XWPFTableRow {
         this.ctRow = row;
     }
 
+    @Internal
     public CTRow getCtRow() {
         return ctRow;
     }