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@1833101 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
PJ Fanning 2018-06-07 07:40:09 +00:00
parent e2195c505f
commit 726c7b3245
2 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartCollection.java
View File

@ -53,6 +53,10 @@ public final class PackagePartCollection implements Serializable {
* recognize a part with a part name derived from another part name by * recognize a part with a part name derived from another part name by
* appending segments to it. * 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 * @exception InvalidOperationException
* Throws if you try to add a part with a name derived from * Throws if you try to add a part with a name derived from
* another part name. * 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 * The values themselves should be returned in sorted order. Doing it here
* avoids paying the high cost of Natural Ordering per insertion. * avoids paying the high cost of Natural Ordering per insertion.
* @return unmodifiable collection of parts
*/ */
public Collection<PackagePart> sortedValues() { public Collection<PackagePart> sortedValues() {
return Collections.unmodifiableCollection(packagePartLookup.values()); return Collections.unmodifiableCollection(packagePartLookup.values());

10
src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java
View File

@ -489,6 +489,11 @@ public final class PackagePartName implements Comparable<PackagePartName> {
* case-insensitive ASCII strings. Packages shall not contain equivalent * case-insensitive ASCII strings. Packages shall not contain equivalent
* part names and package implementers shall neither create nor recognize * part names and package implementers shall neither create nor recognize
* packages with equivalent part names. [M1.12] * 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) { public static int compare(PackagePartName obj1, PackagePartName obj2) {
return compare ( return compare (
@ -506,6 +511,11 @@ public final class PackagePartName implements Comparable<PackagePartName> {
* For example, this sorts "file10.png" after "file2.png" (comparing the * For example, this sorts "file10.png" after "file2.png" (comparing the
* numerical portion), but sorts "File10.png" before "file2.png" * numerical portion), but sorts "File10.png" before "file2.png"
* (lexigraphical sort) * (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) public static int compare(final String str1, final String str2)
{ {