Author: fanningpj
Date: Tue Dec 8 23:01:07 2020
New Revision: 1884219
URL: http://svn.apache.org/viewvc?rev=1884219&view=rev
Log:
[github-200] Update OPCPackage#getPartsByRelationshipType docs to reflect
behavior. Thanks to Marius Volkhart. This closes #200
Modified:
poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
Modified: poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
URL:
http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java?rev=1884219&r1=1884218&r2=1884219&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
(original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java Tue
Dec 8 23:01:07 2020
@@ -646,10 +646,11 @@ public abstract class OPCPackage impleme
* Retrieve parts by relationship type.
*
* @param relationshipType
- * Relationship type.
+ * Relationship type. Must not be {@code null}.
* @return All parts which are the target of a relationship with the
- * specified type, if the method can't retrieve relationships
from
- * the package, then return <code>null</code>.
+ * specified type. If no such parts are found, the list is
empty.
+ * @throws InvalidOperationException If called on a write-only package.
+ * @throws IllegalArgumentException if relationshipType input param is
null.
*/
public ArrayList<PackagePart> getPartsByRelationshipType(
String relationshipType) {
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@poi.apache.org
For additional commands, e-mail: commits-h...@poi.apache.org
