[github-200] Update OPCPackage#getPartsByRelationshipType docs to reflect behavior...

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1884219 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
index 39ff11fa3004a4e72fa6ce27e1b6554fb6915a45..713876a0aaacfc11a8e7120736a7d483f25a81a0 100644 (file)
--- a/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
+++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
@@ -646,10 +646,11 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
         * 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) {