You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ma...@apache.org on 2021/10/01 12:18:01 UTC
svn commit: r1893780 - in /poi/trunk:
poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java
poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFPictureData.java
poi/src/main/java/org/apache/poi/ss/usermodel/PictureData.java
Author: mariusvolkhart
Date: Fri Oct 1 12:18:01 2021
New Revision: 1893780
URL: http://svn.apache.org/viewvc?rev=1893780&view=rev
Log:
Consolidate spreadsheet PictureData javadocs
If docs for an implementation were identical or substantially similar to that of the interface, I removed them from the implementation, as Javadocs inherit automatically.
Modified:
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java
poi/trunk/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFPictureData.java
poi/trunk/poi/src/main/java/org/apache/poi/ss/usermodel/PictureData.java
Modified: poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java?rev=1893780&r1=1893779&r2=1893780&view=diff
==============================================================================
--- poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java (original)
+++ poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java Fri Oct 1 12:18:01 2021
@@ -93,26 +93,12 @@ public class XSSFPictureData extends POI
}
}
- /**
- * Suggests a file extension for this image.
- *
- * @return the file extension.
- */
+ @Override
public String suggestFileExtension() {
return getPackagePart().getPartName().getExtension();
}
- /**
- * Return an integer constant that specifies type of this picture
- *
- * @return an integer constant that specifies type of this picture
- * @see org.apache.poi.ss.usermodel.Workbook#PICTURE_TYPE_EMF
- * @see org.apache.poi.ss.usermodel.Workbook#PICTURE_TYPE_WMF
- * @see org.apache.poi.ss.usermodel.Workbook#PICTURE_TYPE_PICT
- * @see org.apache.poi.ss.usermodel.Workbook#PICTURE_TYPE_JPEG
- * @see org.apache.poi.ss.usermodel.Workbook#PICTURE_TYPE_PNG
- * @see org.apache.poi.ss.usermodel.Workbook#PICTURE_TYPE_DIB
- */
+ @Override
public int getPictureType(){
String contentType = getPackagePart().getContentType();
for (int i = 0; i < RELATIONS.length; i++) {
Modified: poi/trunk/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFPictureData.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFPictureData.java?rev=1893780&r1=1893779&r2=1893780&view=diff
==============================================================================
--- poi/trunk/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFPictureData.java (original)
+++ poi/trunk/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFPictureData.java Fri Oct 1 12:18:01 2021
@@ -102,9 +102,6 @@ public class HSSFPictureData implements
}
}
- /**
- * Returns the mime type for the image
- */
@Override
public String getMimeType() {
switch (EscherRecordTypes.forTypeID(blip.getRecordId())) {
@@ -130,13 +127,6 @@ public class HSSFPictureData implements
/**
* @return the POI internal image type, 0 if unknown image type (was -1 prior to 5.0.0 but
* that was inconsistent with other {@link PictureData} implementations)
- *
- * @see Workbook#PICTURE_TYPE_DIB
- * @see Workbook#PICTURE_TYPE_EMF
- * @see Workbook#PICTURE_TYPE_JPEG
- * @see Workbook#PICTURE_TYPE_PICT
- * @see Workbook#PICTURE_TYPE_PNG
- * @see Workbook#PICTURE_TYPE_WMF
*/
@Override
public int getPictureType() {
Modified: poi/trunk/poi/src/main/java/org/apache/poi/ss/usermodel/PictureData.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/main/java/org/apache/poi/ss/usermodel/PictureData.java?rev=1893780&r1=1893779&r2=1893780&view=diff
==============================================================================
--- poi/trunk/poi/src/main/java/org/apache/poi/ss/usermodel/PictureData.java (original)
+++ poi/trunk/poi/src/main/java/org/apache/poi/ss/usermodel/PictureData.java Fri Oct 1 12:18:01 2021
@@ -29,7 +29,8 @@ public interface PictureData {
/**
* Suggests a file extension for this image.
*
- * @return the file extension.
+ * @return the file extension, without a leading {@code .}. Never {@code null}, but will be empty if the extension
+ * is unknown or if the file backing these data does not have an extension.
*/
String suggestFileExtension();
@@ -39,7 +40,7 @@ public interface PictureData {
String getMimeType();
/**
- * @return the POI internal image type, 0 if unknown image type
+ * @return the POI internal image type, {@code 0} if unknown image type
*
* @see Workbook#PICTURE_TYPE_DIB
* @see Workbook#PICTURE_TYPE_EMF
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org