diff options
| author | PJ Fanning <fanningpj@apache.org> | 2020-12-08 23:01:07 +0000 |
|---|---|---|
| committer | PJ Fanning <fanningpj@apache.org> | 2020-12-08 23:01:07 +0000 |
| commit | 8f13c071217299bb0fc90e42edef8c78cb2484f4 (patch) | |
| tree | 270951ca6ef29206093a82890d7f6d67cecf58c3 | |
| parent | 326ff18e51cccabeef0c4d15d666354399fcd962 (diff) | |
| download | poi-8f13c071217299bb0fc90e42edef8c78cb2484f4.tar.gz poi-8f13c071217299bb0fc90e42edef8c78cb2484f4.zip | |
[github-200] Update OPCPackage#getPartsByRelationshipType docs to reflect behavior. Thanks to Marius Volkhart. This closes #200
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1884219 13f79535-47bb-0310-9956-ffa450edef68
| -rw-r--r-- | src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java | 7 |
1 files changed, 4 insertions, 3 deletions
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 39ff11fa30..713876a0aa 100644 --- 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) { |