added an annotation '@Internal' to mark program elements intended for POI internal use only, marked all public accessors to OOXML xmlbeans as @Internal

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@886846 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Yegor Kozlov 2009-12-03 16:50:34 +00:00
parent ddefe3144d
commit 4a45b78277
31 changed files with 128 additions and 5 deletions

View File

@ -0,0 +1,37 @@
/*
* 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.util;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Retention;
import java.lang.annotation.Documented;
/**
* Program elements annotated @Internal are intended for
* POI internal use only. Such elements are not public by design
* and likely to be removed in future versions of POI or access
* to such elements will be changed from 'public' to 'default' or less.
*
* @author Yegor Kozlov
* @since POI-3.6
*/
@Documented
@Retention(RetentionPolicy.SOURCE)
public @interface Internal {
}

View File

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

View File

@ -19,6 +19,7 @@ package org.apache.poi.xslf.usermodel;
import org.apache.poi.sl.usermodel.Notes; import org.apache.poi.sl.usermodel.Notes;
import org.apache.poi.sl.usermodel.Slide; import org.apache.poi.sl.usermodel.Slide;
import org.apache.poi.sl.usermodel.SlideShow; 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.CTSlide;
import org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry; import org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry;
@ -35,12 +36,14 @@ public class XSLFSlide extends XSLFSheet implements Slide {
/** /**
* While developing only! * While developing only!
*/ */
@Internal
public CTSlide _getCTSlide() { public CTSlide _getCTSlide() {
return slide; return slide;
} }
/** /**
* While developing only! * While developing only!
*/ */
@Internal
public CTSlideIdListEntry _getCTSlideId() { public CTSlideIdListEntry _getCTSlideId() {
return slideId; return slideId;
} }

View File

@ -40,6 +40,7 @@ import org.apache.poi.ss.usermodel.RichTextString;
import org.apache.poi.ss.util.CellReference; import org.apache.poi.ss.util.CellReference;
import org.apache.poi.xssf.model.SharedStringsTable; import org.apache.poi.xssf.model.SharedStringsTable;
import org.apache.poi.xssf.model.StylesTable; 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.CTCell;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCellFormula; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCellFormula;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.STCellFormulaType; 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 * @return the xml bean containing information about this cell
*/ */
@Internal
public CTCell getCTCell(){ public CTCell getCTCell(){
return _cell; return _cell;
} }

View File

@ -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.XSSFCellBorder;
import org.apache.poi.xssf.usermodel.extensions.XSSFCellFill; import org.apache.poi.xssf.usermodel.extensions.XSSFCellFill;
import org.apache.poi.xssf.usermodel.extensions.XSSFCellBorder.BorderSide; 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.CTBorder;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorderPr; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorderPr;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCellAlignment; 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 * Used so that StylesSource can figure out our location
*/ */
@Internal
public CTXf getCoreXf() { public CTXf getCoreXf() {
return _cellXf; return _cellXf;
} }
@ -81,6 +83,7 @@ public class XSSFCellStyle implements CellStyle {
/** /**
* Used so that StylesSource can figure out our location * Used so that StylesSource can figure out our location
*/ */
@Internal
public CTXf getStyleXf() { public CTXf getStyleXf() {
return _cellStyleXf; return _cellStyleXf;
} }

View File

@ -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.CTPoint2D;
import org.openxmlformats.schemas.drawingml.x2006.main.CTPositiveSize2D; import org.openxmlformats.schemas.drawingml.x2006.main.CTPositiveSize2D;
import org.openxmlformats.schemas.drawingml.x2006.main.CTTransform2D; import org.openxmlformats.schemas.drawingml.x2006.main.CTTransform2D;
import org.apache.poi.util.Internal;
/** /**
* @author Yegor Kozlov * @author Yegor Kozlov
@ -44,6 +45,7 @@ public final class XSSFChildAnchor extends XSSFAnchor {
this.t2d = t2d; this.t2d = t2d;
} }
@Internal
public CTTransform2D getCTTransform2D() { public CTTransform2D getCTTransform2D() {
return t2d; return t2d;
} }

View File

@ -18,6 +18,7 @@
package org.apache.poi.xssf.usermodel; package org.apache.poi.xssf.usermodel;
import org.apache.poi.ss.usermodel.ClientAnchor; import org.apache.poi.ss.usermodel.ClientAnchor;
import org.apache.poi.util.Internal;
import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker; import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker;
/** /**
@ -175,6 +176,7 @@ public final class XSSFClientAnchor extends XSSFAnchor implements ClientAnchor {
* *
* @return starting anchor point * @return starting anchor point
*/ */
@Internal
public CTMarker getFrom(){ public CTMarker getFrom(){
return cell1; return cell1;
} }
@ -188,6 +190,7 @@ public final class XSSFClientAnchor extends XSSFAnchor implements ClientAnchor {
* *
* @return ending anchor point * @return ending anchor point
*/ */
@Internal
public CTMarker getTo(){ public CTMarker getTo(){
return cell2; return cell2;
} }

View File

@ -17,6 +17,7 @@
package org.apache.poi.xssf.usermodel; package org.apache.poi.xssf.usermodel;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor;
import org.apache.poi.util.Internal;
/** /**
* Represents a color in SpreadsheetML * Represents a color in SpreadsheetML
@ -197,6 +198,7 @@ public class XSSFColor {
* *
* @return the underlying XML bean * @return the underlying XML bean
*/ */
@Internal
public CTColor getCTColor(){ public CTColor getCTColor(){
return ctColor; return ctColor;
} }

View File

@ -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.main.STShapeType;
import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTConnector; import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTConnector;
import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTConnectorNonVisual; 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. * A connection shape drawing element. A connection shape is a line, etc.
@ -104,6 +105,7 @@ public final class XSSFConnector extends XSSFShape {
return prototype; return prototype;
} }
@Internal
public CTConnector getCTConnector(){ public CTConnector getCTConnector(){
return ctShape; return ctShape;
} }

View File

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

View File

@ -17,6 +17,7 @@
package org.apache.poi.xssf.usermodel; package org.apache.poi.xssf.usermodel;
import org.apache.poi.POIXMLException; import org.apache.poi.POIXMLException;
import org.apache.poi.util.Internal;
import org.apache.poi.ss.usermodel.Font; import org.apache.poi.ss.usermodel.Font;
import org.apache.poi.ss.usermodel.FontCharset; import org.apache.poi.ss.usermodel.FontCharset;
import org.apache.poi.ss.usermodel.FontFamily; import org.apache.poi.ss.usermodel.FontFamily;
@ -88,6 +89,7 @@ public class XSSFFont implements Font {
/** /**
* get the underlying CTFont font * get the underlying CTFont font
*/ */
@Internal
public CTFont getCTFont() { public CTFont getCTFont() {
return _ctFont; return _ctFont;
} }

View File

@ -21,6 +21,7 @@ import java.util.List;
import java.util.Vector; import java.util.Vector;
import org.apache.poi.POIXMLDocumentPart; import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.util.Internal;
import org.apache.poi.xssf.model.MapInfo; import org.apache.poi.xssf.model.MapInfo;
import org.apache.poi.xssf.model.SingleXmlCells; import org.apache.poi.xssf.model.SingleXmlCells;
import org.apache.poi.xssf.model.Table; import org.apache.poi.xssf.model.Table;
@ -53,11 +54,13 @@ public class XSSFMap {
} }
@Internal
public CTMap getCtMap() { public CTMap getCtMap() {
return ctMap; return ctMap;
} }
@Internal
public CTSchema getCTSchema() { public CTSchema getCTSchema() {
String schemaId = ctMap.getSchemaID(); String schemaId = ctMap.getSchemaID();
return mapInfo.getCTSchemaById(schemaId); return mapInfo.getCTSchemaById(schemaId);

View File

@ -34,6 +34,7 @@ import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.util.ImageUtils; import org.apache.poi.ss.util.ImageUtils;
import org.apache.poi.util.POILogFactory; import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger; 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.CTBlipFillProperties;
import org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualDrawingProps; import org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualDrawingProps;
import org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualPictureProperties; 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 * @return the underlying CTPicture bean
*/ */
@Internal
public CTPicture getCTPicture(){ public CTPicture getCTPicture(){
return ctPicture; return ctPicture;
} }

View File

@ -24,6 +24,7 @@ import javax.xml.namespace.QName;
import org.apache.poi.ss.usermodel.Font; import org.apache.poi.ss.usermodel.Font;
import org.apache.poi.ss.usermodel.RichTextString; import org.apache.poi.ss.usermodel.RichTextString;
import org.apache.poi.xssf.model.StylesTable; import org.apache.poi.xssf.model.StylesTable;
import org.apache.poi.util.Internal;
import org.apache.xmlbeans.XmlCursor; import org.apache.xmlbeans.XmlCursor;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTFont; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTFont;
@ -416,6 +417,7 @@ public class XSSFRichTextString implements RichTextString {
/** /**
* Return the underlying xml bean * Return the underlying xml bean
*/ */
@Internal
public CTRst getCTRst() { public CTRst getCTRst() {
return st; return st;
} }

View File

@ -27,6 +27,7 @@ import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.util.CellReference; import org.apache.poi.ss.util.CellReference;
import org.apache.poi.util.POILogFactory; import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger; import org.apache.poi.util.POILogger;
import org.apache.poi.util.Internal;
import org.apache.poi.xssf.model.CalculationChain; import org.apache.poi.xssf.model.CalculationChain;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCell; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCell;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRow; 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 * @return the underlying CTRow xml bean
*/ */
@Internal
public CTRow getCTRow(){ public CTRow getCTRow(){
return _row; return _row;
} }

View File

@ -18,6 +18,7 @@
package org.apache.poi.xssf.usermodel; package org.apache.poi.xssf.usermodel;
import org.apache.poi.openxml4j.opc.PackageRelationship; 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.CTGroupShapeProperties;
import org.openxmlformats.schemas.drawingml.x2006.main.CTGroupTransform2D; import org.openxmlformats.schemas.drawingml.x2006.main.CTGroupTransform2D;
import org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualDrawingProps; import org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualDrawingProps;
@ -163,6 +164,7 @@ public final class XSSFShapeGroup extends XSSFShape {
return shape; return shape;
} }
@Internal
public CTGroupShape getCTGroupShape() { public CTGroupShape getCTGroupShape() {
return ctGroup; return ctGroup;
} }

View File

@ -49,6 +49,7 @@ import org.apache.poi.ss.util.CellRangeAddress;
import org.apache.poi.ss.util.CellReference; import org.apache.poi.ss.util.CellReference;
import org.apache.poi.util.POILogFactory; import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger; import org.apache.poi.util.POILogger;
import org.apache.poi.util.Internal;
import org.apache.poi.xssf.model.CommentsTable; import org.apache.poi.xssf.model.CommentsTable;
import org.apache.poi.xssf.usermodel.helpers.ColumnHelper; import org.apache.poi.xssf.usermodel.helpers.ColumnHelper;
import org.apache.poi.xssf.usermodel.helpers.XSSFRowShifter; 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 * @return the CTWorksheet bean holding this sheet's data
*/ */
@Internal
public CTWorksheet getCTWorksheet() { public CTWorksheet getCTWorksheet() {
return this.worksheet; return this.worksheet;
} }

View File

@ -42,6 +42,7 @@ import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShape;
import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShapeNonVisual; import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShapeNonVisual;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRElt; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRElt;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRPrElt; 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. * 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; return prototype;
} }
@Internal
public CTShape getCTShape(){ public CTShape getCTShape(){
return ctShape; return ctShape;
} }

View File

@ -51,10 +51,7 @@ import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook; import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.usermodel.Row.MissingCellPolicy; import org.apache.poi.ss.usermodel.Row.MissingCellPolicy;
import org.apache.poi.ss.util.CellReference; import org.apache.poi.ss.util.CellReference;
import org.apache.poi.util.IOUtils; import org.apache.poi.util.*;
import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger;
import org.apache.poi.util.PackageHelper;
import org.apache.poi.xssf.model.CalculationChain; import org.apache.poi.xssf.model.CalculationChain;
import org.apache.poi.xssf.model.MapInfo; import org.apache.poi.xssf.model.MapInfo;
import org.apache.poi.xssf.model.SharedStringsTable; 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 * @return the underlying CTWorkbook bean
*/ */
@Internal
public CTWorkbook getCTWorkbook() { public CTWorkbook getCTWorkbook() {
return this.workbook; return this.workbook;
} }
@ -1180,6 +1178,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable<X
* *
* @return the shared string table * @return the shared string table
*/ */
@Internal
public SharedStringsTable getSharedStringSource() { public SharedStringsTable getSharedStringSource() {
return this.sharedStringSource; 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 * @return the <code>CalculationChain</code> object or <code>null</code> if not defined
*/ */
@Internal
public CalculationChain getCalculationChain(){ public CalculationChain getCalculationChain(){
return calcChain; 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 * @return the helper class used to query the custom XML mapping defined in this workbook
*/ */
@Internal
public MapInfo getMapInfo(){ public MapInfo getMapInfo(){
return mapInfo; return mapInfo;
} }

View File

@ -21,6 +21,7 @@ import org.openxmlformats.schemas.spreadsheetml.x2006.main.STHorizontalAlignment
import org.openxmlformats.schemas.spreadsheetml.x2006.main.STVerticalAlignment; import org.openxmlformats.schemas.spreadsheetml.x2006.main.STVerticalAlignment;
import org.apache.poi.ss.usermodel.HorizontalAlignment; import org.apache.poi.ss.usermodel.HorizontalAlignment;
import org.apache.poi.ss.usermodel.VerticalAlignment; 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 * Access to low-level data
*/ */
@Internal
public CTCellAlignment getCTCellAlignment() { public CTCellAlignment getCTCellAlignment() {
return cellAlignement; return cellAlignement;
} }

View File

@ -19,6 +19,7 @@ package org.apache.poi.xssf.usermodel.extensions;
import org.apache.poi.ss.usermodel.BorderStyle; import org.apache.poi.ss.usermodel.BorderStyle;
import org.apache.poi.xssf.usermodel.XSSFColor; 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.CTBorder;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorderPr; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorderPr;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.STBorderStyle; import org.openxmlformats.schemas.spreadsheetml.x2006.main.STBorderStyle;
@ -59,6 +60,7 @@ public class XSSFCellBorder {
* *
* @return CTBorder * @return CTBorder
*/ */
@Internal
public CTBorder getCTBorder() { public CTBorder getCTBorder() {
return border; return border;
} }

View File

@ -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.CTPatternFill;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.STPatternType; import org.openxmlformats.schemas.spreadsheetml.x2006.main.STPatternType;
import org.apache.poi.xssf.usermodel.XSSFColor; import org.apache.poi.xssf.usermodel.XSSFColor;
import org.apache.poi.util.Internal;
/** /**
* This element specifies fill formatting. * This element specifies fill formatting.
@ -147,6 +148,7 @@ public final class XSSFCellFill {
* *
* @return CTFill * @return CTFill
*/ */
@Internal
public CTFill getCTFill() { public CTFill getCTFill() {
return _fill; return _fill;
} }

View File

@ -19,6 +19,7 @@ package org.apache.poi.xssf.usermodel.extensions;
import org.apache.poi.ss.usermodel.HeaderFooter; import org.apache.poi.ss.usermodel.HeaderFooter;
import org.apache.poi.xssf.usermodel.helpers.HeaderFooterHelper; import org.apache.poi.xssf.usermodel.helpers.HeaderFooterHelper;
import org.apache.poi.util.Internal;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHeaderFooter; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHeaderFooter;
/** /**
@ -140,6 +141,7 @@ public abstract class XSSFHeaderFooter implements HeaderFooter {
* *
* @return the underlying CTHeaderFooter xml bean * @return the underlying CTHeaderFooter xml bean
*/ */
@Internal
public CTHeaderFooter getHeaderFooter() { public CTHeaderFooter getHeaderFooter() {
return this.headerFooter; return this.headerFooter;
} }

View File

@ -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; package org.apache.poi.xwpf.usermodel;
import java.math.BigInteger; import java.math.BigInteger;
import org.apache.xmlbeans.impl.xb.xmlschema.SpaceAttribute.Space; 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.CTDecimalNumber;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFonts; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFonts;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
@ -56,7 +73,8 @@ public class TOC {
p.addNewR().addNewT().set("Table of Contents"); p.addNewR().addNewT().set("Table of Contents");
} }
public CTSdtBlock getBlock() { @Internal
public CTSdtBlock getBlock() {
return this.block; return this.block;
} }

View File

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

View File

@ -19,6 +19,7 @@ package org.apache.poi.xwpf.usermodel;
import java.io.IOException; import java.io.IOException;
import org.apache.poi.POIXMLDocumentPart; import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.util.Internal;
import org.apache.poi.openxml4j.opc.PackagePart; import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.openxml4j.opc.PackageRelationship; import org.apache.poi.openxml4j.opc.PackageRelationship;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr;
@ -40,6 +41,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart{
super(part, rel); super(part, rel);
} }
@Internal
public CTHdrFtr _getHdrFtr() { public CTHdrFtr _getHdrFtr() {
return headerFooter; return headerFooter;
} }

View File

@ -22,6 +22,7 @@ import java.util.Arrays;
import org.apache.xmlbeans.XmlCursor; import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlObject; 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.CTBorder;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdnRef; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdnRef;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTInd; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTInd;
@ -149,6 +150,7 @@ public class XWPFParagraph {
} }
} }
@Internal
public CTP getCTP() { public CTP getCTP() {
return paragraph; return paragraph;
} }

View File

@ -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.STOnOff;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STUnderline; import org.openxmlformats.schemas.wordprocessingml.x2006.main.STUnderline;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STVerticalAlignRun; 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 * 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 * Get the currently used CTR object
* @return ctr object * @return ctr object
*/ */
@Internal
public CTR getCTR() { public CTR getCTR() {
return run; return run;
} }

View File

@ -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.CTTc;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STBorder; import org.openxmlformats.schemas.wordprocessingml.x2006.main.STBorder;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STTblWidth; 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. * Sketch of XWPFTable class. Only table's text is being hold.
@ -109,6 +110,7 @@ public class XWPFTable {
/** /**
* @return ctTbl object * @return ctTbl object
*/ */
@Internal
public CTTbl getCTTbl() { public CTTbl getCTTbl() {
return ctTbl; return ctTbl;
} }

View File

@ -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.CTP;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc;
import org.apache.poi.util.Internal;
public class XWPFTableCell { public class XWPFTableCell {
@ -34,6 +35,7 @@ public class XWPFTableCell {
} }
@Internal
public CTTc getCTTc() { public CTTc getCTTc() {
return ctTc; return ctTc;
} }

View File

@ -21,6 +21,7 @@ import java.math.BigInteger;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHeight; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHeight;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRow; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRow;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTrPr; import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTrPr;
import org.apache.poi.util.Internal;
/** /**
@ -34,6 +35,7 @@ public class XWPFTableRow {
this.ctRow = row; this.ctRow = row;
} }
@Internal
public CTRow getCtRow() { public CTRow getCtRow() {
return ctRow; return ctRow;
} }