Package org.apache.poi.openxml4j.opc
Class PackagePartName
java.lang.Object
org.apache.poi.openxml4j.opc.PackagePartName
- All Implemented Interfaces:
Comparable<PackagePartName>
An immutable Open Packaging Convention compliant part name.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic int
A natural sort order for strings, consistent with the requirements ofjava.util.Comparator
, but simply implemented as a static method.static int
compare
(PackagePartName obj1, PackagePartName obj2) A natural sort order for package part names, consistent with the requirements ofjava.util.Comparator
, but simply implemented as a static method.int
compareTo
(PackagePartName other) Compare two part names following the rule M1.12 : Part name equivalence is determined by comparing part names as case-insensitive ASCII strings.boolean
Part name equivalence is determined by comparing part names as case-insensitive ASCII strings.Retrieves the extension of the part name if any.getName()
Get this part name.getURI()
Part name property getter.int
hashCode()
boolean
Know if this part name is a relationship part name.toString()
-
Method Details
-
isRelationshipPartURI
public boolean isRelationshipPartURI()Know if this part name is a relationship part name.- Returns:
true
if this part name respect the relationship part naming convention elsefalse
.
-
compareTo
Compare two part names following the rule M1.12 : Part name equivalence is determined by comparing part names as 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]- Specified by:
compareTo
in interfaceComparable<PackagePartName>
-
getExtension
Retrieves the extension of the part name if any. If there is no extension returns an empty String. Example : '/document/content.xml' => 'xml'- Returns:
- The extension of the part name.
-
getName
Get this part name.- Returns:
- The name of this part name.
-
equals
Part name equivalence is determined by comparing part names as 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] -
hashCode
public int hashCode() -
toString
-
getURI
Part name property getter.- Returns:
- This part name URI.
-
compare
A natural sort order for package part names, consistent with the requirements ofjava.util.Comparator
, but simply implemented as a static method.For example, this sorts "file10.png" after "file2.png" (comparing the numerical portion), but sorts "File10.png" before "file2.png" (lexigraphical sort)
When comparing part names, the rule M1.12 is followed: Part name equivalence is determined by comparing part names as 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]
- Parameters:
obj1
- firstPackagePartName
to compareobj2
- secondPackagePartName
to compare- Returns:
- a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.
-
compare
A natural sort order for strings, consistent with the requirements ofjava.util.Comparator
, but simply implemented as a static method.For example, this sorts "file10.png" after "file2.png" (comparing the numerical portion), but sorts "File10.png" before "file2.png" (lexigraphical sort)
- Parameters:
str1
- first string to comparestr1
- second string to compare- Returns:
- a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.
-