diff options
| author | PJ Fanning <fanningpj@apache.org> | 2018-06-07 07:40:09 +0000 |
|---|---|---|
| committer | PJ Fanning <fanningpj@apache.org> | 2018-06-07 07:40:09 +0000 |
| commit | 6045b277b1879051fade086770d7b65c6dea0c6b (patch) | |
| tree | cc6fa5626960f2aeafbcceedfb75e734cc971754 | |
| parent | bb15bf3aef1628060061d90c9fa69c6c68e4600f (diff) | |
| download | poi-6045b277b1879051fade086770d7b65c6dea0c6b.tar.gz poi-6045b277b1879051fade086770d7b65c6dea0c6b.zip | |
fix some javadoc
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1833101 13f79535-47bb-0310-9956-ffa450edef68
| -rw-r--r-- | src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java | 5 | ||||
| -rw-r--r-- | src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java | 10 |
2 files changed, 15 insertions, 0 deletions
diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java index f1227de436..f295aad99c 100644 --- a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java +++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java @@ -53,6 +53,10 @@ public final class PackagePartCollection implements Serializable { * recognize a part with a part name derived from another part name by * appending segments to it. * + * @param partName name of part + * @param part part to put + * @return the previous value associated with {@code partName}, or + * {@code null} if there was no mapping for {@code partName}. * @exception InvalidOperationException * Throws if you try to add a part with a name derived from * another part name. @@ -89,6 +93,7 @@ public final class PackagePartCollection implements Serializable { /** * The values themselves should be returned in sorted order. Doing it here * avoids paying the high cost of Natural Ordering per insertion. + * @return unmodifiable collection of parts */ public Collection<PackagePart> sortedValues() { return Collections.unmodifiableCollection(packagePartLookup.values()); diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java index db3ee057e5..baee7e2abd 100644 --- a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java +++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java @@ -489,6 +489,11 @@ public final class PackagePartName implements Comparable<PackagePartName> { * case-insensitive ASCII strings. Packages shall not contain equivalent * part names and package implementers shall neither create nor recognize * packages with equivalent part names. [M1.12] + * + * @param obj1 first {@code PackagePartName} to compare + * @param obj2 second {@code PackagePartName} to compare + * @return a negative integer, zero, or a positive integer as the first argument is less than, + * equal to, or greater than the second. */ public static int compare(PackagePartName obj1, PackagePartName obj2) { return compare ( @@ -506,6 +511,11 @@ public final class PackagePartName implements Comparable<PackagePartName> { * For example, this sorts "file10.png" after "file2.png" (comparing the * numerical portion), but sorts "File10.png" before "file2.png" * (lexigraphical sort) + * + * @param str1 first string to compare + * @param str1 second string to compare + * @return a negative integer, zero, or a positive integer as the first argument is less than, + * equal to, or greater than the second. */ public static int compare(final String str1, final String str2) { |