Skip to content

Location parent Javadoc #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sbesson wants to merge 3 commits into from
Closed

Location parent Javadoc #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0046280
Use Java 8 Oracle documentation
sbesson Aug 10, 2017
4e654d9
Copy File Javadoc and fix see also
sbesson Aug 10, 2017
5ad8fb0
Remove whitespace
sbesson Aug 10, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@
<configuration>
<failOnError>false</failOnError>
<links>
<link>http://docs.oracle.com/javase/7/docs/api/</link>
<link>http://docs.oracle.com/javase/8/docs/api/</link>
</links>
</configuration>
<executions>
Expand Down Expand Up @@ -455,7 +455,7 @@
<configuration>
<failOnError>false</failOnError>
<links>
<link>http://docs.oracle.com/javase/7/docs/api/</link>
<link>http://docs.oracle.com/javase/8/docs/api/</link>
</links>
</configuration>
</plugin>
Expand Down
26 changes: 20 additions & 6 deletions src/main/java/loci/common/Location.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@
import com.google.common.collect.MapMaker;

/**
* Pseudo-extension of java.io.File that supports reading over HTTP (among
* other things).
* Pseudo-extension of {@link java.io.File} that supports reading over HTTP
* (among other things).
* It is strongly recommended to use this instead of java.io.File.
*/
public class Location {
Expand Down Expand Up @@ -602,9 +602,13 @@ public String getName() {
}

/**
* Returns the name of this file's parent directory, i.e. the path name prefix
* and every name in the path name sequence except for the last.
* If this file does not have a parent directory, then null is returned.
* Returns the pathname string of this abstract pathname's parent, or null if
* this pathname does not have a parent directory.
*
* The parent of an abstract pathname consists of the pathname's prefix, if
* any, and each name in the pathname's name sequence except for the last.
* If the name sequence is empty then the pathname does not name a parent
* directory.
*
* @see java.io.File#getParent()
*/
Expand All @@ -618,7 +622,17 @@ public String getParent() {
return file.getParent();
}

/* @see java.io.File#getParentFile() */
/**
* Returns the abstract pathname of this abstract pathname's parent, or null
* if this pathname does not name a parent directory.
*
* The parent of an abstract pathname consists of the pathname's prefix, if
* any, and each name in the pathname's name sequence except for the last.
* If the name sequence is empty then the pathname does not name a parent
* directory.
*
* @see java.io.File#getParentFile()
*/
public Location getParentFile() {
String parent = this.getParent();
if (parent == null) return null;
Expand Down