moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

cleaned javadoc warnings

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1004934 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Yegor Kozlov 2010-10-06 08:55:30 +00:00
parent 3a41e5d459
commit adefc926c1
16 changed files with 54 additions and 148 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/java/org/apache/poi/hssf/record/BoundSheetRecord.java
View File

@ -85,7 +85,7 @@ public final class BoundSheetRecord extends StandardRecord {
/** /**
* Set the sheetname for this sheet. (this appears in the tabs at the bottom) * Set the sheetname for this sheet. (this appears in the tabs at the bottom)
* @param sheetName the name of the sheet * @param sheetName the name of the sheet
* @see {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} * @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)
* for a safe way to create valid names * for a safe way to create valid names
* @throws IllegalArgumentException if sheet name will cause excel to crash. * @throws IllegalArgumentException if sheet name will cause excel to crash.
*/ */

4
src/java/org/apache/poi/hssf/record/DVRecord.java
View File

@ -133,7 +133,7 @@ public final class DVRecord extends StandardRecord {
// --> start option flags // --> start option flags
/** /**
* @return the condition data type * @return the condition data type
* @see org.apache.poi.hssf.usermodel.DVConstraint.ValidationType * @see org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType
*/ */
public int getDataType() { public int getDataType() {
return opt_data_type.getValue(_option_flags); return opt_data_type.getValue(_option_flags);
@ -141,7 +141,7 @@ public final class DVRecord extends StandardRecord {
/** /**
* @return the condition error style * @return the condition error style
* @see org.apache.poi.hssf.usermodel.HSSFDataValidation.ErrorStyle * @see org.apache.poi.ss.usermodel.DataValidation.ErrorStyle
*/ */
public int getErrorStyle() { public int getErrorStyle() {
return opt_error_style.getValue(_option_flags); return opt_error_style.getValue(_option_flags);

12
src/java/org/apache/poi/hssf/usermodel/DVConstraint.java
View File

@ -90,9 +90,11 @@ public class DVConstraint implements DataValidationConstraint {
* can be either standard Excel formulas or formatted number values. If the expression starts * can be either standard Excel formulas or formatted number values. If the expression starts
* with '=' it is parsed as a formula, otherwise it is parsed as a formatted number. * with '=' it is parsed as a formula, otherwise it is parsed as a formatted number.
* *
* @param validationType one of {@link ValidationType#ANY}, {@link ValidationType#DECIMAL}, * @param validationType one of {@link org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#ANY},
* {@link ValidationType#INTEGER}, {@link ValidationType#TEXT_LENGTH} * {@link org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#DECIMAL},
* @param comparisonOperator any constant from {@link OperatorType} enum * {@link org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#INTEGER},
* {@link org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#TEXT_LENGTH}
* @param comparisonOperator any constant from {@link org.apache.poi.ss.usermodel.DataValidationConstraint.OperatorType} enum
* @param expr1 date formula (when first char is '=') or formatted number value * @param expr1 date formula (when first char is '=') or formatted number value
* @param expr2 date formula (when first char is '=') or formatted number value * @param expr2 date formula (when first char is '=') or formatted number value
*/ */
@ -140,7 +142,7 @@ public class DVConstraint implements DataValidationConstraint {
* formatted times, two formats are supported: "HH:MM" or "HH:MM:SS". This is contrary to * formatted times, two formats are supported: "HH:MM" or "HH:MM:SS". This is contrary to
* Excel which uses the default time format from the OS. * Excel which uses the default time format from the OS.
* *
* @param comparisonOperator constant from {@link OperatorType} enum * @param comparisonOperator constant from {@link org.apache.poi.ss.usermodel.DataValidationConstraint.OperatorType} enum
* @param expr1 date formula (when first char is '=') or formatted time value * @param expr1 date formula (when first char is '=') or formatted time value
* @param expr2 date formula (when first char is '=') or formatted time value * @param expr2 date formula (when first char is '=') or formatted time value
*/ */
@ -166,7 +168,7 @@ public class DVConstraint implements DataValidationConstraint {
* the same convention). To parse formatted dates, a date format needs to be specified. This * the same convention). To parse formatted dates, a date format needs to be specified. This
* is contrary to Excel which uses the default short date format from the OS. * is contrary to Excel which uses the default short date format from the OS.
* *
* @param comparisonOperator constant from {@link OperatorType} enum * @param comparisonOperator constant from {@link org.apache.poi.ss.usermodel.DataValidationConstraint.OperatorType} enum
* @param expr1 date formula (when first char is '=') or formatted date value * @param expr1 date formula (when first char is '=') or formatted date value
* @param expr2 date formula (when first char is '=') or formatted date value * @param expr2 date formula (when first char is '=') or formatted date value
* @param dateFormat ignored if both expr1 and expr2 are formulas. Default value is "YYYY/MM/DD" * @param dateFormat ignored if both expr1 and expr2 are formulas. Default value is "YYYY/MM/DD"

7
src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
View File

@ -326,7 +326,8 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss
* contained strings will be written to the Shared String tabel (SSTRecord) within * contained strings will be written to the Shared String tabel (SSTRecord) within
* the Workbook. * the Workbook.
* *
* @param wb sheet's matching low level Workbook structure containing the SSTRecord. * @param records a collection of sheet's records.
* @param offset the offset to search at
* @see org.apache.poi.hssf.record.LabelRecord * @see org.apache.poi.hssf.record.LabelRecord
* @see org.apache.poi.hssf.record.LabelSSTRecord * @see org.apache.poi.hssf.record.LabelSSTRecord
* @see org.apache.poi.hssf.record.SSTRecord * @see org.apache.poi.hssf.record.SSTRecord
@ -727,8 +728,8 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss
* *
* @param sheetname the name for the new sheet. Note - certain length limits * @param sheetname the name for the new sheet. Note - certain length limits
* apply. See {@link #setSheetName(int, String)}. * apply. See {@link #setSheetName(int, String)}.
* @see {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} * @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)
* for a safe way to create valid names * for a safe way to create valid names
* @return HSSFSheet representing the new sheet. * @return HSSFSheet representing the new sheet.
* @throws IllegalArgumentException * @throws IllegalArgumentException
* if there is already a sheet present with a case-insensitive * if there is already a sheet present with a case-insensitive

8
src/ooxml/java/org/apache/poi/xwpf/usermodel/IBody.java
View File

@ -40,14 +40,14 @@ public interface IBody {
* returns the Part, to which the body belongs, which you need for adding relationship to other parts * returns the Part, to which the body belongs, which you need for adding relationship to other parts
* Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell * Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell
* belongs. * belongs.
* @return * @return the Part, to which the body belongs
*/ */
IBody getPart(); IBody getPart();
/** /**
* get the PartType of the body, for example * get the PartType of the body, for example
* DOCUMENT, HEADER, FOOTER, FOOTNOTE, * DOCUMENT, HEADER, FOOTER, FOOTNOTE,
* @return * @return the PartType of the body
*/ */
BodyType getPartType(); BodyType getPartType();
@ -86,7 +86,6 @@ public interface IBody {
* the method will return this table * the method will return this table
* if there is no corresponding {@link XWPFTable} the method will return null * if there is no corresponding {@link XWPFTable} the method will return null
* @param ctTable * @param ctTable
* @return
*/ */
public XWPFTable getTable(CTTbl ctTable); public XWPFTable getTable(CTTbl ctTable);
@ -103,14 +102,12 @@ public interface IBody {
/** /**
*inserts a new paragraph at position of the cursor *inserts a new paragraph at position of the cursor
* @param cursor * @param cursor
* @return
*/ */
public XWPFParagraph insertNewParagraph(XmlCursor cursor); public XWPFParagraph insertNewParagraph(XmlCursor cursor);
/** /**
* inserts a new Table at the cursor position. * inserts a new Table at the cursor position.
* @param cursor * @param cursor
* @return
*/ */
public XWPFTable insertNewTbl(XmlCursor cursor); public XWPFTable insertNewTbl(XmlCursor cursor);
@ -124,7 +121,6 @@ public interface IBody {
/** /**
* returns the TableCell to which the Table belongs * returns the TableCell to which the Table belongs
* @param cell * @param cell
* @return
*/ */
XWPFTableCell getTableCell(CTTc cell); XWPFTableCell getTableCell(CTTc cell);

87
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
View File

@ -280,7 +280,6 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
/** /**
* returns an Iterator with paragraphs and tables * returns an Iterator with paragraphs and tables
* @see org.apache.poi.xwpf.usermodel.IBody#getBodyElements() * @see org.apache.poi.xwpf.usermodel.IBody#getBodyElements()
* @return
*/ */
public List<IBodyElement> getBodyElements(){ public List<IBodyElement> getBodyElements(){
return Collections.unmodifiableList(bodyElements); return Collections.unmodifiableList(bodyElements);
@ -295,7 +294,6 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
/** /**
* @see org.apache.poi.xwpf.usermodel.IBody#getTables() * @see org.apache.poi.xwpf.usermodel.IBody#getTables()
* @return
*/ */
public List<XWPFTable> getTables(){ public List<XWPFTable> getTables(){
return Collections.unmodifiableList(tables); return Collections.unmodifiableList(tables);
@ -313,52 +311,32 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
/** /**
* *
* @return * @return the list of footers
*/ */
public List<XWPFFooter> getFooterList(){ public List<XWPFFooter> getFooterList(){
return Collections.unmodifiableList(footers); return Collections.unmodifiableList(footers);
} }
/**
*
* @param pos
* @return
*/
public XWPFFooter getFooterArray(int pos){ public XWPFFooter getFooterArray(int pos){
return footers.get(pos); return footers.get(pos);
} }
/** /**
* *
* @return * @return the list of headers
*/ */
public List<XWPFHeader> getHeaderList(){ public List<XWPFHeader> getHeaderList(){
return Collections.unmodifiableList(headers); return Collections.unmodifiableList(headers);
} }
/**
*
* @param pos
* @return
*/
public XWPFHeader getHeaderArray(int pos){ public XWPFHeader getHeaderArray(int pos){
return headers.get(pos); return headers.get(pos);
} }
/**
*
* @param table
* @return
*/
public String getTblStyle(XWPFTable table){ public String getTblStyle(XWPFTable table){
return table.getStyleID(); return table.getStyleID();
} }
/**
*
* @param id
* @return
*/
public XWPFHyperlink getHyperlinkByID(String id) { public XWPFHyperlink getHyperlinkByID(String id) {
Iterator<XWPFHyperlink> iter = hyperlinks.iterator(); Iterator<XWPFHyperlink> iter = hyperlinks.iterator();
while(iter.hasNext()) while(iter.hasNext())
@ -371,36 +349,18 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
return null; return null;
} }
/**
*
* @param id
* @return
*/
public XWPFFootnote getFootnoteByID(int id) { public XWPFFootnote getFootnoteByID(int id) {
return footnotes.get(id); return footnotes.get(id);
} }
/**
*
* @param id
* @return
*/
public XWPFFootnote getEndnoteByID(int id) { public XWPFFootnote getEndnoteByID(int id) {
return endnotes.get(id); return endnotes.get(id);
} }
/**
*
* @return
*/
public Collection<XWPFFootnote> getFootnotes() { public Collection<XWPFFootnote> getFootnotes() {
return Collections.unmodifiableCollection(footnotes == null ? new ArrayList<XWPFFootnote>() : footnotes.values()); return Collections.unmodifiableCollection(footnotes == null ? new ArrayList<XWPFFootnote>() : footnotes.values());
} }
/**
*
* @return
*/
public XWPFHyperlink[] getHyperlinks() { public XWPFHyperlink[] getHyperlinks() {
return hyperlinks.toArray( return hyperlinks.toArray(
new XWPFHyperlink[hyperlinks.size()] new XWPFHyperlink[hyperlinks.size()]
@ -547,7 +507,6 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
/** /**
* add a new paragraph at position of the cursor * add a new paragraph at position of the cursor
* @param cursor * @param cursor
* @return
*/ */
public XWPFParagraph insertNewParagraph(XmlCursor cursor){ public XWPFParagraph insertNewParagraph(XmlCursor cursor){
if(isCursorInBody(cursor)){ if(isCursorInBody(cursor)){
@ -583,11 +542,6 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
return null; return null;
} }
/**
*
* @param cursor
* @return
*/
public XWPFTable insertNewTbl(XmlCursor cursor) { public XWPFTable insertNewTbl(XmlCursor cursor) {
if(isCursorInBody(cursor)){ if(isCursorInBody(cursor)){
String uri = CTTbl.type.getName().getNamespaceURI(); String uri = CTTbl.type.getName().getNamespaceURI();
@ -626,7 +580,6 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
/** /**
* verifies that cursor is on the right position * verifies that cursor is on the right position
* @param cursor * @param cursor
* @return
*/ */
private boolean isCursorInBody(XmlCursor cursor) { private boolean isCursorInBody(XmlCursor cursor) {
XmlCursor verify = cursor.newCursor(); XmlCursor verify = cursor.newCursor();
@ -642,7 +595,6 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
/** /**
* get position of the paragraph * get position of the paragraph
* @param p * @param p
* @return
*/ */
public Integer getPosOfParagraph(XWPFParagraph p){ public Integer getPosOfParagraph(XWPFParagraph p){
int i, pos = 0; int i, pos = 0;
@ -740,8 +692,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
} }
/** /**
* get the LastParagraph of the document * @return the LastParagraph of the document
* @return
*/ */
public XWPFParagraph getLastParagraph(){ public XWPFParagraph getLastParagraph(){
int lastPos = paragraphs.toArray().length - 1; int lastPos = paragraphs.toArray().length - 1;
@ -787,8 +738,9 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
} }
} }
/**Replace content of table in array tables at position pos with a /**Replace content of table in array tables at position pos with a
* @param pos, table * @param pos
* @param table
*/ */
public void setTable(int pos, XWPFTable table){ public void setTable(int pos, XWPFTable table){
tables.set(pos, table); tables.set(pos, table);
@ -938,7 +890,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
/** /**
* inserts an existing XWPFTable to the arrays bodyElements and tables * inserts an existing XWPFTable to the arrays bodyElements and tables
* @param i * @param pos
* @param table * @param table
*/ */
public void insertTable(int pos, XWPFTable table) { public void insertTable(int pos, XWPFTable table) {
@ -953,10 +905,6 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
tables.add(i, table); tables.add(i, table);
} }
/**
*
* @return
*/
public List<XWPFPictureData> getAllPictures() { public List<XWPFPictureData> getAllPictures() {
if(pictures == null){ if(pictures == null){
pictures = new ArrayList<XWPFPictureData>(); pictures = new ArrayList<XWPFPictureData>();
@ -970,8 +918,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
} }
/** /**
* get all Pictures in this package * @return all Pictures in this package
* @return
*/ */
public List<XWPFPictureData> getAllPackagePictures(){ public List<XWPFPictureData> getAllPackagePictures(){
List<XWPFPictureData> pkgpictures = new ArrayList<XWPFPictureData>(); List<XWPFPictureData> pkgpictures = new ArrayList<XWPFPictureData>();
@ -1006,7 +953,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
/** /**
* Adds a picture to the document. * Adds a picture to the document.
* *
* @param is The stream to read image from * @param pictureData The bytes to read image from
* @param format The format of the picture. * @param format The format of the picture.
* *
* @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} . * @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} .
@ -1023,7 +970,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
/** /**
* get the next free ImageNumber * get the next free ImageNumber
* @param format * @param format
* @return * @return the next free ImageNumber
* @throws InvalidFormatException * @throws InvalidFormatException
*/ */
public int getNextPicNameNumber(int format) throws InvalidFormatException{ public int getNextPicNameNumber(int format) throws InvalidFormatException{
@ -1067,7 +1014,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
/** /**
* get Styles * get Styles
* @return * @return styles for this document
*/ */
public XWPFStyles getStyles(){ public XWPFStyles getStyles(){
return styles; return styles;
@ -1075,8 +1022,9 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
/** /**
* get the paragraph with the CTP class p * get the paragraph with the CTP class p
*
* @param p * @param p
* @return * @return the paragraph with the CTP class p
*/ */
public XWPFParagraph getParagraph(CTP p){ public XWPFParagraph getParagraph(CTP p){
for(int i=0; i<getParagraphs().size(); i++){ for(int i=0; i<getParagraphs().size(); i++){
@ -1089,7 +1037,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
* get a table by its CTTbl-Object * get a table by its CTTbl-Object
* @param ctTbl * @param ctTbl
* @see org.apache.poi.xwpf.usermodel.IBody#getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl) * @see org.apache.poi.xwpf.usermodel.IBody#getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl)
* @return * @return a table by its CTTbl-Object or null
*/ */
public XWPFTable getTable(CTTbl ctTbl) { public XWPFTable getTable(CTTbl ctTbl) {
for(int i=0; i<tables.size(); i++){ for(int i=0; i<tables.size(); i++){
@ -1132,8 +1080,8 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
/** /**
* get the PartType of the body, for example * get the PartType of the body, for example
* DOCUMENT, HEADER, FOOTER, FOOTNOTE, * DOCUMENT, HEADER, FOOTER, FOOTNOTE,
* @return *
* @see org.apache.poi.xwpf.usermodel.IBody#getPartType() * @see org.apache.poi.xwpf.usermodel.IBody#getPartType()
*/ */
public BodyType getPartType() { public BodyType getPartType() {
@ -1142,8 +1090,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
/** /**
* get the TableCell which belongs to the TableCell * get the TableCell which belongs to the TableCell
* @param o * @param cell
* @return
*/ */
public XWPFTableCell getTableCell(CTTc cell) { public XWPFTableCell getTableCell(CTTc cell) {
XmlCursor cursor = cell.newCursor(); XmlCursor cursor = cell.newCursor();

1
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeader.java
View File

@ -103,7 +103,6 @@ public class XWPFHeader extends XWPFHeaderFooter {
/** /**
* reads the document * reads the document
* @overide onDocumentRead of class {@link POIXMLDocumentPart}
*/ */
@Override @Override
protected void onDocumentRead(){ protected void onDocumentRead(){

22
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java
View File

@ -142,7 +142,6 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
* the method will return this table * the method will return this table
* if there is no corresponding {@link XWPFTable} the method will return null * if there is no corresponding {@link XWPFTable} the method will return null
* @param ctTable * @param ctTable
* @return
*/ */
public XWPFTable getTable(CTTbl ctTable){ public XWPFTable getTable(CTTbl ctTable){
for (XWPFTable table : tables) { for (XWPFTable table : tables) {
@ -202,7 +201,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
/** /**
* get all Pictures in this package * get all Pictures in this package
* @return * @return all Pictures in this package
*/ */
public List<XWPFPictureData> getAllPackagePictures(){ public List<XWPFPictureData> getAllPackagePictures(){
List<XWPFPictureData> pkgpictures = new ArrayList<XWPFPictureData>(); List<XWPFPictureData> pkgpictures = new ArrayList<XWPFPictureData>();
@ -237,7 +236,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
/** /**
* Adds a picture to the document. * Adds a picture to the document.
* *
* @param is The stream to read image from * @param pictureData The picture bytes
* @param format The format of the picture. * @param format The format of the picture.
* *
* @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} . * @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} .
@ -260,7 +259,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
/** /**
* get the next free ImageNumber * get the next free ImageNumber
* @param format * @param format
* @return * @return the next free ImageNumber
*/ */
public int getNextPicNameNumber(int format){ public int getNextPicNameNumber(int format){
int img = getAllPackagePictures().size()+1; int img = getAllPackagePictures().size()+1;
@ -301,7 +300,8 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
/** /**
* Add the picture to drawing relations * Add the picture to drawing relations
* *
* @param img the PictureData of the Picture, * @param pictureData the picture bytes
* @param format the picture format
*/ */
public PackageRelationship addPictureReference(byte[] pictureData, int format){ public PackageRelationship addPictureReference(byte[] pictureData, int format){
int imageNumber = getNextPicNameNumber(format); int imageNumber = getNextPicNameNumber(format);
@ -322,7 +322,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
/** /**
* Add the picture to drawing relations * Add the picture to drawing relations
* *
* @param img the PictureData of the Picture, * @param is the stream to read picture data from
*/ */
public PackageRelationship addPictureReference(InputStream is, int format){ public PackageRelationship addPictureReference(InputStream is, int format){
@ -345,7 +345,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
/** /**
* add a new paragraph at position of the cursor * add a new paragraph at position of the cursor
* @param cursor * @param cursor
* @return * @return the inserted paragraph
*/ */
public XWPFParagraph insertNewParagraph(XmlCursor cursor){ public XWPFParagraph insertNewParagraph(XmlCursor cursor){
if(isCursorInHdrF(cursor)){ if(isCursorInHdrF(cursor)){
@ -385,7 +385,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
/** /**
* *
* @param cursor * @param cursor
* @return * @return the inserted table
*/ */
public XWPFTable insertNewTbl(XmlCursor cursor) { public XWPFTable insertNewTbl(XmlCursor cursor) {
if(isCursorInHdrF(cursor)){ if(isCursorInHdrF(cursor)){
@ -425,7 +425,6 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
/** /**
* verifies that cursor is on the right position * verifies that cursor is on the right position
* @param cursor * @param cursor
* @return
*/ */
private boolean isCursorInHdrF(XmlCursor cursor) { private boolean isCursorInHdrF(XmlCursor cursor) {
XmlCursor verify = cursor.newCursor(); XmlCursor verify = cursor.newCursor();
@ -455,7 +454,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
/** /**
* inserts an existing XWPFTable to the arrays bodyElements and tables * inserts an existing XWPFTable to the arrays bodyElements and tables
* @param i * @param pos
* @param table * @param table
*/ */
public void insertTable(int pos, XWPFTable table) { public void insertTable(int pos, XWPFTable table) {
@ -497,8 +496,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
/** /**
* get the TableCell which belongs to the TableCell * get the TableCell which belongs to the TableCell
* @param o * @param cell
* @return
*/ */
public XWPFTableCell getTableCell(CTTc cell) { public XWPFTableCell getTableCell(CTTc cell) {
XmlCursor cursor = cell.newCursor(); XmlCursor cursor = cell.newCursor();

2
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java
View File

@ -232,7 +232,7 @@ public class XWPFNumbering extends POIXMLDocumentPart {
*return the abstractNumID *return the abstractNumID
*If the AbstractNumID not exists *If the AbstractNumID not exists
*return null *return null
* @param num * @param numID
* @return abstractNumID * @return abstractNumID
*/ */
public BigInteger getAbstractNumID(BigInteger numID){ public BigInteger getAbstractNumID(BigInteger numID){

14
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java
View File

@ -1106,8 +1106,7 @@ public class XWPFParagraph implements IBodyElement{
* If it finds the string, it will return true and the position of the String * If it finds the string, it will return true and the position of the String
* will be saved in the parameter startPos. * will be saved in the parameter startPos.
* @param searched * @param searched
* @param pos * @param startPos
* @return
*/ */
public TextSegement searchText(String searched,PositionInParagraph startPos){ public TextSegement searchText(String searched,PositionInParagraph startPos){
@ -1172,7 +1171,7 @@ public class XWPFParagraph implements IBodyElement{
/** /**
* insert a new Run in RunArray * insert a new Run in RunArray
* @param pos * @param pos
* @return * @return the inserted run
*/ */
public XWPFRun insertNewRun(int pos){ public XWPFRun insertNewRun(int pos){
if (pos >= 0 && pos <= paragraph.sizeOfRArray()) { if (pos >= 0 && pos <= paragraph.sizeOfRArray()) {
@ -1188,8 +1187,7 @@ public class XWPFParagraph implements IBodyElement{
/** /**
* get a Text * get a Text
* @param posList * @param segment
* @return
*/ */
public String getText(TextSegement segment){ public String getText(TextSegement segment){
int runBegin = segment.getBeginRun(); int runBegin = segment.getBeginRun();
@ -1223,7 +1221,7 @@ public class XWPFParagraph implements IBodyElement{
/** /**
* removes a Run at the position pos in the paragraph * removes a Run at the position pos in the paragraph
* @param pos * @param pos
* @return * @return true if the run was removed
*/ */
public boolean removeRun(int pos){ public boolean removeRun(int pos){
if (pos >= 0 && pos < paragraph.sizeOfRArray()){ if (pos >= 0 && pos < paragraph.sizeOfRArray()){
@ -1263,8 +1261,6 @@ public class XWPFParagraph implements IBodyElement{
/** /**
* adds a new Run to the Paragraph * adds a new Run to the Paragraph
* @param r
* @return
*/ */
public void addRun(XWPFRun r){ public void addRun(XWPFRun r){
runs.add(r); runs.add(r);
@ -1272,8 +1268,6 @@ public class XWPFParagraph implements IBodyElement{
/** /**
* return the XWPFRun-Element which owns the CTR run-Element * return the XWPFRun-Element which owns the CTR run-Element
* @param r
* @return
*/ */
public XWPFRun getRun(CTR r){ public XWPFRun getRun(CTR r){
for(int i=0; i < getRuns().size(); i++){ for(int i=0; i < getRuns().size(); i++){

3
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFStyle.java
View File

@ -109,7 +109,6 @@ public class XWPFStyle {
/** /**
* get StyleID of the linked Style * get StyleID of the linked Style
* @return
*/ */
public String getLinkStyleID(){ public String getLinkStyleID(){
if (ctStyle.getLink()!=null) if (ctStyle.getLink()!=null)
@ -120,7 +119,6 @@ public class XWPFStyle {
/** /**
* get StyleID of the next style * get StyleID of the next style
* @return
*/ */
public String getNextStyleID(){ public String getNextStyleID(){
if(ctStyle.getNext()!=null) if(ctStyle.getNext()!=null)
@ -138,7 +136,6 @@ public class XWPFStyle {
/** /**
* compares the names of the Styles * compares the names of the Styles
* @param compStyle * @param compStyle
* @return
*/ */
public boolean hasSameName(XWPFStyle compStyle){ public boolean hasSameName(XWPFStyle compStyle){
CTStyle ctCompStyle = compStyle.getCTStyle(); CTStyle ctCompStyle = compStyle.getCTStyle();

3
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFStyles.java
View File

@ -177,7 +177,6 @@ public class XWPFStyles extends POIXMLDocumentPart{
/** /**
* get latentstyles * get latentstyles
* @return
*/ */
public XWPFLatentStyles getLatentStyles() { public XWPFLatentStyles getLatentStyles() {
return latentStyles; return latentStyles;
@ -186,8 +185,6 @@ public class XWPFStyles extends POIXMLDocumentPart{
/** /**
* get the style with the same name * get the style with the same name
* if this style is not existing, return null * if this style is not existing, return null
* @param style
* @return
*/ */
public XWPFStyle getStyleWithSameName(XWPFStyle style){ public XWPFStyle getStyleWithSameName(XWPFStyle style){
for (XWPFStyle ownStyle : listStyle) { for (XWPFStyle ownStyle : listStyle) {

9
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTable.java
View File

@ -250,7 +250,7 @@ public class XWPFTable implements IBodyElement{
/** /**
* inserts a new tablerow * inserts a new tablerow
* @param pos * @param pos
* @return * @return the inserted row
*/ */
public XWPFTableRow insertNewTableRow(int pos){ public XWPFTableRow insertNewTableRow(int pos){
if(pos >= 0 && pos <= tableRows.size()){ if(pos >= 0 && pos <= tableRows.size()){
@ -276,11 +276,6 @@ public class XWPFTable implements IBodyElement{
return false; return false;
} }
/**
*
* @param pos
* @return
*/
public List<XWPFTableRow> getRows() { public List<XWPFTableRow> getRows() {
return tableRows; return tableRows;
} }
@ -318,8 +313,6 @@ public class XWPFTable implements IBodyElement{
/** /**
* returns the XWPFRow which belongs to the CTRow row * returns the XWPFRow which belongs to the CTRow row
* if this row is not existing in the table null will be returned * if this row is not existing in the table null will be returned
* @param row
* @return
*/ */
public XWPFTableRow getRow(CTRow row) { public XWPFTableRow getRow(CTRow row) {
for(int i=0; i<getRows().size(); i++){ for(int i=0; i<getRows().size(); i++){

17
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTableCell.java
View File

@ -77,7 +77,6 @@ public class XWPFTableCell implements IBody {
/** /**
* returns an Iterator with paragraphs and tables * returns an Iterator with paragraphs and tables
* @see org.apache.poi.xwpf.usermodel.IBody#getBodyElements() * @see org.apache.poi.xwpf.usermodel.IBody#getBodyElements()
* @return
*/ */
public List<IBodyElement> getBodyElements(){ public List<IBodyElement> getBodyElements(){
return Collections.unmodifiableList(bodyElements); return Collections.unmodifiableList(bodyElements);
@ -92,7 +91,6 @@ public class XWPFTableCell implements IBody {
/** /**
* returns a list of paragraphs * returns a list of paragraphs
* @return
*/ */
public List<XWPFParagraph> getParagraphs(){ public List<XWPFParagraph> getParagraphs(){
return paragraphs; return paragraphs;
@ -155,7 +153,7 @@ public class XWPFTableCell implements IBody {
/** /**
* add a new paragraph at position of the cursor * add a new paragraph at position of the cursor
* @param cursor * @param cursor
* @return * @return the inserted paragraph
*/ */
public XWPFParagraph insertNewParagraph(XmlCursor cursor){ public XWPFParagraph insertNewParagraph(XmlCursor cursor){
if(!isCursorInTableCell(cursor)) if(!isCursorInTableCell(cursor))
@ -191,11 +189,6 @@ public class XWPFTableCell implements IBody {
return newP; return newP;
} }
/**
*
* @param cursor
* @return
*/
public XWPFTable insertNewTbl(XmlCursor cursor) { public XWPFTable insertNewTbl(XmlCursor cursor) {
if(isCursorInTableCell(cursor)){ if(isCursorInTableCell(cursor)){
String uri = CTTbl.type.getName().getNamespaceURI(); String uri = CTTbl.type.getName().getNamespaceURI();
@ -233,8 +226,6 @@ public class XWPFTableCell implements IBody {
/** /**
* verifies that cursor is on the right position * verifies that cursor is on the right position
* @param cursor
* @return
*/ */
private boolean isCursorInTableCell(XmlCursor cursor) { private boolean isCursorInTableCell(XmlCursor cursor) {
XmlCursor verify = cursor.newCursor(); XmlCursor verify = cursor.newCursor();
@ -290,7 +281,7 @@ public class XWPFTableCell implements IBody {
/** /**
* @see org.apache.poi.xwpf.usermodel.IBodyPart#getTableArray(int) * @see org.apache.poi.xwpf.usermodel.IBody#getTableArray(int)
*/ */
public XWPFTable getTableArray(int pos) { public XWPFTable getTableArray(int pos) {
if(pos > 0 && pos < tables.size()){ if(pos > 0 && pos < tables.size()){
@ -301,7 +292,7 @@ public class XWPFTableCell implements IBody {
/** /**
* @see org.apache.poi.xwpf.usermodel.IBodyPart#getTables() * @see org.apache.poi.xwpf.usermodel.IBody#getTables()
*/ */
public List<XWPFTable> getTables() { public List<XWPFTable> getTables() {
return Collections.unmodifiableList(tables); return Collections.unmodifiableList(tables);
@ -335,8 +326,6 @@ public class XWPFTableCell implements IBody {
/** /**
* get the TableCell which belongs to the TableCell * get the TableCell which belongs to the TableCell
* @param o
* @return
*/ */
public XWPFTableCell getTableCell(CTTc cell) { public XWPFTableCell getTableCell(CTTc cell) {
XmlCursor cursor = cell.newCursor(); XmlCursor cursor = cell.newCursor();

7
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFTableRow.java
View File

@ -57,10 +57,6 @@ public class XWPFTableRow {
return tableCell; return tableCell;
} }
/**
* @param pos
* @return
*/
public XWPFTableCell getCell(int pos) { public XWPFTableCell getCell(int pos) {
if (pos >= 0 && pos < ctRow.sizeOfTcArray()) { if (pos >= 0 && pos < ctRow.sizeOfTcArray()) {
return getTableCells().get(pos); return getTableCells().get(pos);
@ -70,7 +66,6 @@ public class XWPFTableRow {
/** /**
* adds a new TableCell at the end of this tableRow * adds a new TableCell at the end of this tableRow
* @return
*/ */
public XWPFTableCell addNewTableCell(){ public XWPFTableCell addNewTableCell(){
CTTc cell = ctRow.addNewTc(); CTTc cell = ctRow.addNewTc();
@ -138,8 +133,6 @@ public class XWPFTableRow {
/** /**
* returns the XWPFTableCell which belongs to the CTTC cell * returns the XWPFTableCell which belongs to the CTTC cell
* if there is no XWPFTableCell which belongs to the parameter CTTc cell null will be returned * if there is no XWPFTableCell which belongs to the parameter CTTc cell null will be returned
* @param cell
* @return
*/ */
public XWPFTableCell getTableCell(CTTc cell) { public XWPFTableCell getTableCell(CTTc cell) {
for(int i=0; i<tableCells.size(); i++){ for(int i=0; i<tableCells.size(); i++){

4
src/scratchpad/src/org/apache/poi/hwpf/model/CharIndexTranslator.java
View File

@ -50,7 +50,7 @@ public interface CharIndexTranslator {
* Return first index >= bytePos that is in table * Return first index >= bytePos that is in table
* *
* @param bytePos * @param bytePos
* @return * @return first index greater or equal to bytePos that is in table
*/ */
public int lookIndexForward(int bytePos); public int lookIndexForward(int bytePos);
@ -58,7 +58,7 @@ public interface CharIndexTranslator {
* Return last index <= bytePos that is in table * Return last index <= bytePos that is in table
* *
* @param bytePos * @param bytePos
* @return * @return last index less of equal to bytePos that is in table
*/ */
public int lookIndexBackward(int bytePos); public int lookIndexBackward(int bytePos);