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

fix some javadoc

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1833106 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
PJ Fanning 2018-06-07 08:37:28 +00:00
parent 726c7b3245
commit 232bf3a776
1 changed files with 627 additions and 618 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePart.java
View File

@ -121,6 +121,8 @@ public abstract class PackagePart implements RelationshipSource, Comparable<Pack
* @param contentType * @param contentType
* The Multipurpose Internet Mail Extensions (MIME) content type * The Multipurpose Internet Mail Extensions (MIME) content type
* of the part's data stream. * of the part's data stream.
* @throws InvalidFormatException
* If the specified URI is not valid.
*/ */
public PackagePart(OPCPackage pack, PackagePartName partName, public PackagePart(OPCPackage pack, PackagePartName partName,
String contentType) throws InvalidFormatException { String contentType) throws InvalidFormatException {
@ -466,6 +468,8 @@ public abstract class PackagePart implements RelationshipSource, Comparable<Pack
* *
* @param rel A relationship from this part to another one * @param rel A relationship from this part to another one
* @return The target part of the relationship * @return The target part of the relationship
* @throws InvalidFormatException
* If the specified URI is not valid.
*/ */
public PackagePart getRelatedPart(PackageRelationship rel) throws InvalidFormatException { public PackagePart getRelatedPart(PackageRelationship rel) throws InvalidFormatException {
// Ensure this is one of ours // Ensure this is one of ours
@ -515,6 +519,7 @@ public abstract class PackagePart implements RelationshipSource, Comparable<Pack
* order to write inside (the standard Java API doesn't allow to write in * order to write inside (the standard Java API doesn't allow to write in
* the file) * the file)
* *
* @return output stream for this part
* @see org.apache.poi.openxml4j.opc.internal.MemoryPackagePart * @see org.apache.poi.openxml4j.opc.internal.MemoryPackagePart
*/ */
public OutputStream getOutputStream() { public OutputStream getOutputStream() {
@ -670,8 +675,9 @@ public abstract class PackagePart implements RelationshipSource, Comparable<Pack
/*-------------- Abstract methods ------------- */ /*-------------- Abstract methods ------------- */
/** /**
* Abstract method that get the input stream of this part. * Method that gets the input stream for this part.
* *
* @return input stream for this part
* @exception IOException * @exception IOException
* Throws if an IO Exception occur in the implementation * Throws if an IO Exception occur in the implementation
* method. * method.
@ -679,7 +685,9 @@ public abstract class PackagePart implements RelationshipSource, Comparable<Pack
protected abstract InputStream getInputStreamImpl() throws IOException; protected abstract InputStream getInputStreamImpl() throws IOException;
/** /**
* Abstract method that get the output stream of this part. * Method that gets the output stream for this part.
*
* @return output stream for this part
*/ */
protected abstract OutputStream getOutputStreamImpl(); protected abstract OutputStream getOutputStreamImpl();
@ -690,6 +698,7 @@ public abstract class PackagePart implements RelationshipSource, Comparable<Pack
* *
* @param zos * @param zos
* Output stream to save this part. * Output stream to save this part.
* @return boolean flag that shows if the save succeeded
* @throws OpenXML4JException * @throws OpenXML4JException
* If any exception occur. * If any exception occur.
*/ */