From 16fbd2d7e51ca4089aea78440b9e97374913c329 Mon Sep 17 00:00:00 2001 From: Carl Quinn Date: Tue, 24 Feb 2009 11:31:04 +0000 Subject: [PATCH] 6809132: (file) Javadoc style and consistency issues Reviewed-by: vinnie --- .../java/nio/file/AccessDeniedException.java | 8 +- .../file/AtomicMoveNotSupportedException.java | 6 +- .../nio/file/DirectoryNotEmptyException.java | 2 +- .../java/nio/file/DirectoryStream.java | 14 +- .../java/nio/file/DirectoryStreamFilters.java | 18 +- .../classes/java/nio/file/FileAction.java | 6 +- .../nio/file/FileAlreadyExistsException.java | 8 +- .../classes/java/nio/file/FileStore.java | 16 +- .../FileSystemAlreadyExistsException.java | 2 +- .../java/nio/file/FileSystemException.java | 14 +- .../nio/file/FileSystemNotFoundException.java | 2 +- .../classes/java/nio/file/FileSystems.java | 66 ++--- .../classes/java/nio/file/FileVisitor.java | 16 +- .../java/nio/file/InvalidPathException.java | 24 +- .../classes/java/nio/file/LinkPermission.java | 10 +- .../java/nio/file/NoSuchFileException.java | 8 +- .../java/nio/file/NotDirectoryException.java | 2 +- .../java/nio/file/NotLinkException.java | 8 +- jdk/src/share/classes/java/nio/file/Path.java | 251 +++++++++--------- .../classes/java/nio/file/PathMatcher.java | 2 +- .../share/classes/java/nio/file/Paths.java | 28 +- .../nio/file/ProviderMismatchException.java | 2 +- .../nio/file/ProviderNotFoundException.java | 2 +- .../java/nio/file/SecureDirectoryStream.java | 72 ++--- .../java/nio/file/SimpleFileVisitor.java | 6 +- .../classes/java/nio/file/WatchEvent.java | 6 +- .../share/classes/java/nio/file/WatchKey.java | 4 +- .../classes/java/nio/file/WatchService.java | 18 +- .../classes/java/nio/file/Watchable.java | 34 +-- .../java/nio/file/attribute/AclEntry.java | 32 +-- .../file/attribute/AclFileAttributeView.java | 8 +- .../nio/file/attribute/AttributeView.java | 32 +-- .../attribute/BasicFileAttributeView.java | 16 +- .../file/attribute/BasicFileAttributes.java | 10 +- .../file/attribute/DosFileAttributeView.java | 16 +- .../nio/file/attribute/DosFileAttributes.java | 8 +- .../attribute/FileOwnerAttributeView.java | 6 +- .../attribute/PosixFileAttributeView.java | 12 +- .../file/attribute/PosixFileAttributes.java | 6 +- .../file/attribute/PosixFilePermissions.java | 16 +- .../attribute/UserPrincipalLookupService.java | 16 +- .../UserPrincipalNotFoundException.java | 4 +- .../classes/java/nio/file/package-info.java | 2 +- 43 files changed, 425 insertions(+), 414 deletions(-) diff --git a/jdk/src/share/classes/java/nio/file/AccessDeniedException.java b/jdk/src/share/classes/java/nio/file/AccessDeniedException.java index 72e3e2afded..82a4fd2d54e 100644 --- a/jdk/src/share/classes/java/nio/file/AccessDeniedException.java +++ b/jdk/src/share/classes/java/nio/file/AccessDeniedException.java @@ -46,7 +46,7 @@ public class AccessDeniedException * Constructs an instance of this class. * * @param file - * A string identifying the file or {@code null} if not known. + * a string identifying the file or {@code null} if not known */ public AccessDeniedException(String file) { super(file); @@ -56,11 +56,11 @@ public class AccessDeniedException * Constructs an instance of this class. * * @param file - * A string identifying the file or {@code null} if not known. + * a string identifying the file or {@code null} if not known * @param other - * A string identifying the other file or {@code null} if not known. + * a string identifying the other file or {@code null} if not known * @param reason - * A reason message with additional information or {@code null} + * a reason message with additional information or {@code null} */ public AccessDeniedException(String file, String other, String reason) { super(file, other, reason); diff --git a/jdk/src/share/classes/java/nio/file/AtomicMoveNotSupportedException.java b/jdk/src/share/classes/java/nio/file/AtomicMoveNotSupportedException.java index de68cae87a2..503d24c2e91 100644 --- a/jdk/src/share/classes/java/nio/file/AtomicMoveNotSupportedException.java +++ b/jdk/src/share/classes/java/nio/file/AtomicMoveNotSupportedException.java @@ -41,11 +41,11 @@ public class AtomicMoveNotSupportedException * Constructs an instance of this class. * * @param source - * A string identifying the source file or {@code null} if not known. + * a string identifying the source file or {@code null} if not known * @param target - * A string identifying the target file or {@code null} if not known. + * a string identifying the target file or {@code null} if not known * @param reason - * A reason message with additional information + * a reason message with additional information */ public AtomicMoveNotSupportedException(String source, String target, diff --git a/jdk/src/share/classes/java/nio/file/DirectoryNotEmptyException.java b/jdk/src/share/classes/java/nio/file/DirectoryNotEmptyException.java index e5d78ec94e9..482b476410d 100644 --- a/jdk/src/share/classes/java/nio/file/DirectoryNotEmptyException.java +++ b/jdk/src/share/classes/java/nio/file/DirectoryNotEmptyException.java @@ -41,7 +41,7 @@ public class DirectoryNotEmptyException * Constructs an instance of this class. * * @param dir - * A string identifying the directory or {@code null} if not known. + * a string identifying the directory or {@code null} if not known */ public DirectoryNotEmptyException(String dir) { super(dir); diff --git a/jdk/src/share/classes/java/nio/file/DirectoryStream.java b/jdk/src/share/classes/java/nio/file/DirectoryStream.java index 0b5a4aef682..589d7b4f5e9 100644 --- a/jdk/src/share/classes/java/nio/file/DirectoryStream.java +++ b/jdk/src/share/classes/java/nio/file/DirectoryStream.java @@ -59,9 +59,9 @@ import java.io.Closeable; * with cause {@link ClosedDirectoryStreamException}. * *

A directory stream is not required to be asynchronously closeable. - * If a thread is blocked on the directory stream's iterator, reading from the - * directory, and another thread invokes the {@code close} method then it may - * require to block until the read operation is complete. + * If a thread is blocked on the directory stream's iterator reading from the + * directory, and another thread invokes the {@code close} method, then the + * second thread may block until the read operation is complete. * *

The {@link Iterator#hasNext() hasNext} and {@link Iterator#next() next} * methods can encounter an I/O error when iterating over the directory in which @@ -108,7 +108,7 @@ public interface DirectoryStream * create filters for a number of common usages and also methods to combine * filters. * - * @param The type of the directory entry + * @param the type of the directory entry * * @since 1.7 */ @@ -117,7 +117,7 @@ public interface DirectoryStream * Decides if the given directory entry should be accepted or filtered. * * @param entry - * The directory entry to be tested + * the directory entry to be tested * * @return {@code true} if the directory entry should be accepted */ @@ -127,10 +127,10 @@ public interface DirectoryStream /** * Returns the iterator associated with this {@code DirectoryStream}. * - * @return The iterator associated with this {@code DirectoryStream} + * @return the iterator associated with this {@code DirectoryStream} * * @throws IllegalStateException - * If this directory stream is closed or the iterator has already + * if this directory stream is closed or the iterator has already * been returned */ @Override diff --git a/jdk/src/share/classes/java/nio/file/DirectoryStreamFilters.java b/jdk/src/share/classes/java/nio/file/DirectoryStreamFilters.java index 39fcf3abcb1..b582bbf93bc 100644 --- a/jdk/src/share/classes/java/nio/file/DirectoryStreamFilters.java +++ b/jdk/src/share/classes/java/nio/file/DirectoryStreamFilters.java @@ -78,12 +78,12 @@ public final class DirectoryStreamFilters { * * * @param type - * The content type + * the content type * - * @return A new directory stream filter + * @return a new directory stream filter * * @throws IllegalArgumentException - * If the {@code type} parameter cannot be parsed as a MIME type + * if the {@code type} parameter cannot be parsed as a MIME type * or it has parameters */ public static DirectoryStream.Filter @@ -128,9 +128,9 @@ public final class DirectoryStreamFilters { * * * @param filters - * The sequence of filters + * the sequence of filters * - * @return The resulting filter + * @return the resulting filter */ public static DirectoryStream.Filter allOf(final Iterable> filters) @@ -162,9 +162,9 @@ public final class DirectoryStreamFilters { * entries. * * @param filters - * The sequence of filters + * the sequence of filters * - * @return The resulting filter + * @return the resulting filter */ public static DirectoryStream.Filter anyOf(final Iterable> filters) @@ -191,9 +191,9 @@ public final class DirectoryStreamFilters { * by the given filter. * * @param filter - * The given filter + * the given filter * - * @return The resulting filter that is the complement of the given filter + * @return the resulting filter that is the complement of the given filter */ public static DirectoryStream.Filter complementOf(final DirectoryStream.Filter filter) diff --git a/jdk/src/share/classes/java/nio/file/FileAction.java b/jdk/src/share/classes/java/nio/file/FileAction.java index 9b235e6b8a3..58088c2f814 100644 --- a/jdk/src/share/classes/java/nio/file/FileAction.java +++ b/jdk/src/share/classes/java/nio/file/FileAction.java @@ -45,7 +45,7 @@ import java.io.IOException; * }); * * - * @param The type of file reference + * @param the type of file reference * * @since 1.7 */ @@ -55,10 +55,10 @@ public interface FileAction { * Invoked for a file. * * @param file - * The file + * the file * * @throws IOException - * If the block terminates due an uncaught I/O exception + * if the block terminates due an uncaught I/O exception */ void invoke(T file) throws IOException; } diff --git a/jdk/src/share/classes/java/nio/file/FileAlreadyExistsException.java b/jdk/src/share/classes/java/nio/file/FileAlreadyExistsException.java index b52c09fe216..ff60e6371d1 100644 --- a/jdk/src/share/classes/java/nio/file/FileAlreadyExistsException.java +++ b/jdk/src/share/classes/java/nio/file/FileAlreadyExistsException.java @@ -41,7 +41,7 @@ public class FileAlreadyExistsException * Constructs an instance of this class. * * @param file - * A string identifying the file or {@code null} if not known. + * a string identifying the file or {@code null} if not known */ public FileAlreadyExistsException(String file) { super(file); @@ -51,11 +51,11 @@ public class FileAlreadyExistsException * Constructs an instance of this class. * * @param file - * A string identifying the file or {@code null} if not known. + * a string identifying the file or {@code null} if not known * @param other - * A string identifying the other file or {@code null} if not known. + * a string identifying the other file or {@code null} if not known * @param reason - * A reason message with additional information or {@code null} + * a reason message with additional information or {@code null} */ public FileAlreadyExistsException(String file, String other, String reason) { super(file, other, reason); diff --git a/jdk/src/share/classes/java/nio/file/FileStore.java b/jdk/src/share/classes/java/nio/file/FileStore.java index 2bb3f59cfbd..3f8df103129 100644 --- a/jdk/src/share/classes/java/nio/file/FileStore.java +++ b/jdk/src/share/classes/java/nio/file/FileStore.java @@ -61,7 +61,7 @@ public abstract class FileStore { *

The string returned by this method may differ from the string * returned by the {@link Object#toString() toString} method. * - * @return The name of this file store + * @return the name of this file store */ public abstract String name(); @@ -71,7 +71,7 @@ public abstract class FileStore { * indicate, for example, the format used or if the file store is local * or remote. * - * @return A string representing the type of this file store + * @return a string representing the type of this file store */ public abstract String type(); @@ -96,7 +96,7 @@ public abstract class FileStore { * this are implementation specific and therefore unspecified. * * @param type - * The file attribute view type + * the file attribute view type * * @return {@code true} if, and only if, the file attribute view is * supported @@ -115,7 +115,7 @@ public abstract class FileStore { * specific and therefore unspecified. * * @param name - * The {@link FileAttributeView#name name} of file attribute view + * the {@link FileAttributeView#name name} of file attribute view * * @return {@code true} if, and only if, the file attribute view is * supported @@ -137,9 +137,9 @@ public abstract class FileStore { * always return an instance of that class. * * @param type - * The {@code Class} object corresponding to the attribute view + * the {@code Class} object corresponding to the attribute view * - * @return A file store attribute view of the specified type or + * @return a file store attribute view of the specified type or * {@code null} if the attribute view is not available */ public abstract V @@ -160,9 +160,9 @@ public abstract class FileStore { * of that class. * * @param name - * The name of the attribute view + * the name of the attribute view * - * @return A file store attribute view of the given name, or {@code null} + * @return a file store attribute view of the given name, or {@code null} * if the attribute view is not available */ public abstract FileStoreAttributeView getFileStoreAttributeView(String name); diff --git a/jdk/src/share/classes/java/nio/file/FileSystemAlreadyExistsException.java b/jdk/src/share/classes/java/nio/file/FileSystemAlreadyExistsException.java index fde0f2c8a1e..68c4e153b32 100644 --- a/jdk/src/share/classes/java/nio/file/FileSystemAlreadyExistsException.java +++ b/jdk/src/share/classes/java/nio/file/FileSystemAlreadyExistsException.java @@ -45,7 +45,7 @@ public class FileSystemAlreadyExistsException * Constructs an instance of this class. * * @param msg - * The detail message + * the detail message */ public FileSystemAlreadyExistsException(String msg) { super(msg); diff --git a/jdk/src/share/classes/java/nio/file/FileSystemException.java b/jdk/src/share/classes/java/nio/file/FileSystemException.java index 369e35e89bd..8735dd8795d 100644 --- a/jdk/src/share/classes/java/nio/file/FileSystemException.java +++ b/jdk/src/share/classes/java/nio/file/FileSystemException.java @@ -48,7 +48,7 @@ public class FileSystemException * information to explain the reason. * * @param file - * A string identifying the file or {@code null} if not known. + * a string identifying the file or {@code null} if not known. */ public FileSystemException(String file) { super((String)null); @@ -62,12 +62,12 @@ public class FileSystemException * information to explain the reason. * * @param file - * A string identifying the file or {@code null} if not known. + * a string identifying the file or {@code null} if not known. * @param other - * A string identifying the other file or {@code null} if there + * a string identifying the other file or {@code null} if there * isn't another file or if not known * @param reason - * A reason message with additional information or {@code null} + * a reason message with additional information or {@code null} */ public FileSystemException(String file, String other, String reason) { super(reason); @@ -78,7 +78,7 @@ public class FileSystemException /** * Returns the file used to create this exception. * - * @return The file (can be {@code null}) + * @return the file (can be {@code null}) */ public String getFile() { return file; @@ -87,7 +87,7 @@ public class FileSystemException /** * Returns the other file used to create this exception. * - * @return The other file (can be {@code null}) + * @return the other file (can be {@code null}) */ public String getOtherFile() { return other; @@ -96,7 +96,7 @@ public class FileSystemException /** * Returns the string explaining why the file system operation failed. * - * @return The string explaining why the file system operation failed + * @return the string explaining why the file system operation failed */ public String getReason() { return super.getMessage(); diff --git a/jdk/src/share/classes/java/nio/file/FileSystemNotFoundException.java b/jdk/src/share/classes/java/nio/file/FileSystemNotFoundException.java index 4a2041bc842..7cb58cada21 100644 --- a/jdk/src/share/classes/java/nio/file/FileSystemNotFoundException.java +++ b/jdk/src/share/classes/java/nio/file/FileSystemNotFoundException.java @@ -44,7 +44,7 @@ public class FileSystemNotFoundException * Constructs an instance of this class. * * @param msg - * The detail message + * the detail message */ public FileSystemNotFoundException(String msg) { super(msg); diff --git a/jdk/src/share/classes/java/nio/file/FileSystems.java b/jdk/src/share/classes/java/nio/file/FileSystems.java index 05922e59683..28885f8afee 100644 --- a/jdk/src/share/classes/java/nio/file/FileSystems.java +++ b/jdk/src/share/classes/java/nio/file/FileSystems.java @@ -201,14 +201,14 @@ public final class FileSystems { * default} file system, no permission check is required. * * @throws IllegalArgumentException - * If the pre-conditions for the {@code uri} parameter aren't met + * if the pre-conditions for the {@code uri} parameter are not met * @throws FileSystemNotFoundException - * If the file system, identified by the URI, does not exist + * if the file system, identified by the URI, does not exist * @throws ProviderNotFoundException - * If a provider supporting the URI scheme is not installed + * if a provider supporting the URI scheme is not installed * @throws SecurityException - * If a security manager is installed and it denies an unspecified - * permission. + * if a security manager is installed and it denies an unspecified + * permission */ public static FileSystem getFileSystem(URI uri) { String scheme = uri.getScheme(); @@ -245,25 +245,25 @@ public final class FileSystems { * * * @param uri - * The URI identifying the file system + * the URI identifying the file system * @param env - * A map of provider specific properties to configure the file system; + * a map of provider specific properties to configure the file system; * may be empty * - * @return A new file system + * @return a new file system * * @throws IllegalArgumentException - * If the pre-conditions for the {@code uri} parameter aren't met, + * if the pre-conditions for the {@code uri} parameter are not met, * or the {@code env} parameter does not contain properties required * by the provider, or a property value is invalid * @throws FileSystemAlreadyExistsException - * If the file system has already been created + * if the file system has already been created * @throws ProviderNotFoundException - * If a provider supporting the URI scheme is not installed + * if a provider supporting the URI scheme is not installed * @throws IOException - * An I/O error occurs creating the file system + * if an I/O error occurs creating the file system * @throws SecurityException - * If a security manager is installed and it denies an unspecified + * if a security manager is installed and it denies an unspecified * permission required by the file system provider implementation */ public static FileSystem newFileSystem(URI uri, Map env) @@ -284,31 +284,31 @@ public final class FileSystems { * invoked to construct the new file system. * * @param uri - * The URI identifying the file system + * the URI identifying the file system * @param env - * A map of provider specific properties to configure the file system; + * a map of provider specific properties to configure the file system; * may be empty * @param loader - * The class loader to locate the provider or {@code null} to only + * the class loader to locate the provider or {@code null} to only * attempt to locate an installed provider * - * @return A new file system + * @return a new file system * * @throws IllegalArgumentException - * If the pre-conditions for the {@code uri} parameter aren't met, + * if the pre-conditions for the {@code uri} parameter are not met, * or the {@code env} parameter does not contain properties required * by the provider, or a property value is invalid * @throws FileSystemAlreadyExistsException - * If the URI scheme identifies an installed provider and the file + * if the URI scheme identifies an installed provider and the file * system has already been created * @throws ProviderNotFoundException - * If a provider supporting the URI scheme is not found + * if a provider supporting the URI scheme is not found * @throws ServiceConfigurationError - * When an error occurs while loading a service provider + * when an error occurs while loading a service provider * @throws IOException - * An I/O error occurs creating the file system + * an I/O error occurs creating the file system * @throws SecurityException - * If a security manager is installed and it denies an unspecified + * if a security manager is installed and it denies an unspecified * permission required by the file system provider implementation */ public static FileSystem newFileSystem(URI uri, Map env, ClassLoader loader) @@ -357,28 +357,28 @@ public final class FileSystems { * terminates and the file system is returned. * * @param file - * A reference to a file + * a reference to a file * @param env - * A map of provider specific properties to configure the file system; + * a map of provider specific properties to configure the file system; * may be empty * @param loader - * The class loader to locate the provider or {@code null} to only + * the class loader to locate the provider or {@code null} to only * attempt to locate an installed provider * - * @return A new file system + * @return a new file system * * @throws IllegalArgumentException - * If the {@code env} parameter does not contain properties required + * if the {@code env} parameter does not contain properties required * by the provider, or a property value is invalid * @throws ProviderNotFoundException - * If a provider supporting this file type cannot be located + * if a provider supporting this file type cannot be located * @throws ServiceConfigurationError - * When an error occurs while loading a service provider + * when an error occurs while loading a service provider * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException - * If a security manager is installed and it denies an unspecified - * permission. + * if a security manager is installed and it denies an unspecified + * permission */ public static FileSystem newFileSystem(FileRef file, Map env, diff --git a/jdk/src/share/classes/java/nio/file/FileVisitor.java b/jdk/src/share/classes/java/nio/file/FileVisitor.java index 1f53d0765a6..6d65eba27a9 100644 --- a/jdk/src/share/classes/java/nio/file/FileVisitor.java +++ b/jdk/src/share/classes/java/nio/file/FileVisitor.java @@ -112,7 +112,7 @@ public interface FileVisitor { * directory (and any descendants) will not be visited. * * @param dir - * A reference to the directory + * a reference to the directory * * @return the visit result */ @@ -122,9 +122,9 @@ public interface FileVisitor { * Invoked for a directory that could not be opened. * * @param dir - * A reference to the directory + * a reference to the directory * @param exc - * The I/O exception thrown from the attempt to open the directory + * the I/O exception thrown from the attempt to open the directory * * @return the visit result */ @@ -134,9 +134,9 @@ public interface FileVisitor { * Invoked for a file in a directory. * * @param file - * A reference to the file + * a reference to the file * @param attrs - * The file's basic attributes + * the file's basic attributes * * @return the visit result */ @@ -146,9 +146,9 @@ public interface FileVisitor { * Invoked for a file when its basic file attributes could not be read. * * @param file - * A reference to the file + * a reference to the file * @param exc - * The I/O exception thrown from the attempt to read the file + * the I/O exception thrown from the attempt to read the file * attributes * * @return the visit result @@ -163,7 +163,7 @@ public interface FileVisitor { * or an I/O error when iterating over the directory). * * @param dir - * A reference to the directory + * a reference to the directory * @param exc * {@code null} if the iteration of the directory completes without * an error; otherwise the I/O exception that caused the iteration diff --git a/jdk/src/share/classes/java/nio/file/InvalidPathException.java b/jdk/src/share/classes/java/nio/file/InvalidPathException.java index 5327f056f7d..37f23202c63 100644 --- a/jdk/src/share/classes/java/nio/file/InvalidPathException.java +++ b/jdk/src/share/classes/java/nio/file/InvalidPathException.java @@ -43,16 +43,16 @@ public class InvalidPathException * Constructs an instance from the given input string, reason, and error * index. * - * @param input The input string - * @param reason A string explaining why the input was rejected - * @param index The index at which the error occurred, + * @param input the input string + * @param reason a string explaining why the input was rejected + * @param index the index at which the error occurred, * or -1 if the index is not known * * @throws NullPointerException - * If either the input or reason strings are null + * if either the input or reason strings are null * * @throws IllegalArgumentException - * If the error index is less than -1 + * if the error index is less than -1 */ public InvalidPathException(String input, String reason, int index) { super(reason); @@ -68,11 +68,11 @@ public class InvalidPathException * Constructs an instance from the given input string and reason. The * resulting object will have an error index of -1. * - * @param input The input string - * @param reason A string explaining why the input was rejected + * @param input the input string + * @param reason a string explaining why the input was rejected * * @throws NullPointerException - * If either the input or reason strings are null + * if either the input or reason strings are null */ public InvalidPathException(String input, String reason) { this(input, reason, -1); @@ -81,7 +81,7 @@ public class InvalidPathException /** * Returns the input string. * - * @return The input string + * @return the input string */ public String getInput() { return input; @@ -90,7 +90,7 @@ public class InvalidPathException /** * Returns a string explaining why the input string was rejected. * - * @return The reason string + * @return the reason string */ public String getReason() { return super.getMessage(); @@ -100,7 +100,7 @@ public class InvalidPathException * Returns an index into the input string of the position at which the * error occurred, or -1 if this position is not known. * - * @return The error index + * @return the error index */ public int getIndex() { return index; @@ -114,7 +114,7 @@ public class InvalidPathException * decimal, is inserted after the reason string and before the colon * character. * - * @return A string describing the error + * @return a string describing the error */ public String getMessage() { StringBuffer sb = new StringBuffer(); diff --git a/jdk/src/share/classes/java/nio/file/LinkPermission.java b/jdk/src/share/classes/java/nio/file/LinkPermission.java index f3f2c87be69..d17788fd029 100644 --- a/jdk/src/share/classes/java/nio/file/LinkPermission.java +++ b/jdk/src/share/classes/java/nio/file/LinkPermission.java @@ -75,10 +75,10 @@ public final class LinkPermission extends BasicPermission { * Constructs a {@code LinkPermission} with the specified name. * * @param name - * The name of the permission. It must be "hard" or "symbolic". + * the name of the permission. It must be "hard" or "symbolic". * * @throws IllegalArgumentException - * If name is empty or invalid. + * if name is empty or invalid */ public LinkPermission(String name) { super(name); @@ -89,13 +89,13 @@ public final class LinkPermission extends BasicPermission { * Constructs a {@code LinkPermission} with the specified name. * * @param name - * The name of the permission; must be "hard" or "symbolic". + * the name of the permission; must be "hard" or "symbolic". * @param actions - * The actions for the permission; must be the empty string or + * the actions for the permission; must be the empty string or * {@code null} * * @throws IllegalArgumentException - * If name is empty or invalid. + * if name is empty or invalid */ public LinkPermission(String name, String actions) { super(name); diff --git a/jdk/src/share/classes/java/nio/file/NoSuchFileException.java b/jdk/src/share/classes/java/nio/file/NoSuchFileException.java index e7cf5d4de73..ccde9ae95e7 100644 --- a/jdk/src/share/classes/java/nio/file/NoSuchFileException.java +++ b/jdk/src/share/classes/java/nio/file/NoSuchFileException.java @@ -41,7 +41,7 @@ public class NoSuchFileException * Constructs an instance of this class. * * @param file - * A string identifying the file or {@code null} if not known. + * a string identifying the file or {@code null} if not known. */ public NoSuchFileException(String file) { super(file); @@ -51,11 +51,11 @@ public class NoSuchFileException * Constructs an instance of this class. * * @param file - * A string identifying the file or {@code null} if not known. + * a string identifying the file or {@code null} if not known. * @param other - * A string identifying the other file or {@code null} if not known. + * a string identifying the other file or {@code null} if not known. * @param reason - * A reason message with additional information or {@code null} + * a reason message with additional information or {@code null} */ public NoSuchFileException(String file, String other, String reason) { super(file, other, reason); diff --git a/jdk/src/share/classes/java/nio/file/NotDirectoryException.java b/jdk/src/share/classes/java/nio/file/NotDirectoryException.java index 3b7405b49d2..684bd2df44e 100644 --- a/jdk/src/share/classes/java/nio/file/NotDirectoryException.java +++ b/jdk/src/share/classes/java/nio/file/NotDirectoryException.java @@ -41,7 +41,7 @@ public class NotDirectoryException * Constructs an instance of this class. * * @param file - * A string identifying the file or {@code null} if not known. + * a string identifying the file or {@code null} if not known */ public NotDirectoryException(String file) { super(file); diff --git a/jdk/src/share/classes/java/nio/file/NotLinkException.java b/jdk/src/share/classes/java/nio/file/NotLinkException.java index 2396dff39e7..bdc1fc354ad 100644 --- a/jdk/src/share/classes/java/nio/file/NotLinkException.java +++ b/jdk/src/share/classes/java/nio/file/NotLinkException.java @@ -41,7 +41,7 @@ public class NotLinkException * Constructs an instance of this class. * * @param file - * A string identifying the file or {@code null} if not known. + * a string identifying the file or {@code null} if not known */ public NotLinkException(String file) { super(file); @@ -51,11 +51,11 @@ public class NotLinkException * Constructs an instance of this class. * * @param file - * A string identifying the file or {@code null} if not known. + * a string identifying the file or {@code null} if not known * @param other - * A string identifying the other file or {@code null} if not known. + * a string identifying the other file or {@code null} if not known * @param reason - * A reason message with additional information or {@code null} + * a reason message with additional information or {@code null} */ public NotLinkException(String file, String other, String reason) { super(file, other, reason); diff --git a/jdk/src/share/classes/java/nio/file/Path.java b/jdk/src/share/classes/java/nio/file/Path.java index 25107462a76..55bf8fd2675 100644 --- a/jdk/src/share/classes/java/nio/file/Path.java +++ b/jdk/src/share/classes/java/nio/file/Path.java @@ -37,7 +37,8 @@ import java.util.*; * *

On many platforms a path is the means to locate and access files * in a file system. A path is hierarchical and composed of a sequence of - * directory names separated by a special separator or delimiter. + * directory and file name elements separated by a special separator or + * delimiter. * *

Path operations

* @@ -141,7 +142,7 @@ public abstract class Path /** * Returns the file system that created this object. * - * @return The file system that created this object + * @return the file system that created this object */ public abstract FileSystem getFileSystem(); @@ -159,7 +160,7 @@ public abstract class Path * Returns the root component of this path as a {@code Path} object, * or {@code null} if this path does not have a root component. * - * @return A path representing the root component of this path, + * @return a path representing the root component of this path, * or {@code null} */ public abstract Path getRoot(); @@ -169,7 +170,7 @@ public abstract class Path * file name is the farthest element from the root in the directory * hierarchy. * - * @return A path representing the name of the file or directory, or + * @return a path representing the name of the file or directory, or * {@code null} if this path has zero elements */ public abstract Path getName(); @@ -195,14 +196,14 @@ public abstract class Path * subpath(0, getNameCount()-1); * * - * @return A path representing the path's parent + * @return a path representing the path's parent */ public abstract Path getParent(); /** * Returns the number of name elements in the path. * - * @return The number of elements in the path, or {@code 0} if this path + * @return the number of elements in the path, or {@code 0} if this path * only represents a root component */ public abstract int getNameCount(); @@ -216,14 +217,14 @@ public abstract class Path * has index {@link #getNameCount count}{@code -1}. * * @param index - * The index of the element + * the index of the element * - * @return The name element + * @return the name element * * @throws IllegalArgumentException - * If {@code index} is negative, {@code index} is greater than or + * if {@code index} is negative, {@code index} is greater than or * equal to the number of elements, or this path has zero name - * elements. + * elements */ public abstract Path getName(int index); @@ -240,15 +241,15 @@ public abstract class Path * endIndex-1}. * * @param beginIndex - * The index of the first element, inclusive + * the index of the first element, inclusive * @param endIndex - * The index of the last element, exclusive + * the index of the last element, exclusive * - * @return A new {@code Path} object that is a subsequence of the name + * @return a new {@code Path} object that is a subsequence of the name * elements in this {@code Path} * * @throws IllegalArgumentException - * If {@code beginIndex} is negative, or greater than or equal to + * if {@code beginIndex} is negative, or greater than or equal to * the number of elements. If {@code endIndex} is less than or * equal to {@code beginIndex}, or larger than the number of elements. */ @@ -269,7 +270,7 @@ public abstract class Path * this path does not start with the given path. * * @param other - * The given path + * the given path * * @return {@code true} if this path starts with the given path; otherwise * {@code false} @@ -293,7 +294,7 @@ public abstract class Path * then this path does not end with the given path. * * @param other - * The given path + * the given path * * @return {@code true} if this path ends with the given path; otherwise * {@code false} @@ -318,9 +319,9 @@ public abstract class Path * path may result in the path that locates a different file than the original * path. This can arise when the preceding name is a symbolic link. * - * @return The resulting path, or this path if it does not contain + * @return the resulting path, or this path if it does not contain * redundant name elements, or {@code null} if this path does not - * have a root component and all name elements are redundant. + * have a root component and all name elements are redundant * * @see #getParent * @see #toRealPath @@ -344,9 +345,9 @@ public abstract class Path * unspecified. * * @param other - * The path to resolve against this path; can be {@code null} + * the path to resolve against this path; can be {@code null} * - * @return The resulting path + * @return the resulting path * * @see #relativize */ @@ -358,9 +359,9 @@ public abstract class Path * #resolve(Path) resolve} method. * * @param other - * The path string to resolve against this path + * the path string to resolve against this path * - * @return The resulting path + * @return the resulting path * * @throws InvalidPathException * If the path string cannot be converted to a Path. @@ -400,13 +401,13 @@ public abstract class Path * dependent if {@code "a/b/../x"} would locate the same file as {@code "/a/x"}. * * @param other - * The resulting path + * the resulting path * - * @return The resulting relative path, or {@code null} if both paths are + * @return the resulting relative path, or {@code null} if both paths are * equal * * @throws IllegalArgumentException - * If {@code other} is not a {@code Path} that can be relativized + * if {@code other} is not a {@code Path} that can be relativized * against this path */ public abstract Path relativize(Path other); @@ -440,18 +441,18 @@ public abstract class Path * exist * * @throws NoSuchFileException - * If the value of the {@code failIfNotExists} is {@code true} and + * if the value of the {@code failIfNotExists} is {@code true} and * the file does not exist (optional specific exception) * @throws DirectoryNotEmptyException - * If the file is a directory and could not otherwise be deleted + * if the file is a directory and could not otherwise be deleted * because the directory is not empty (optional specific * exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkDelete(String)} method - * is invoked to check delete access to the file + * is invoked to check delete access to the file. */ public abstract void delete(boolean failIfNotExists) throws IOException; @@ -476,22 +477,22 @@ public abstract class Path * create symbolic links, in which case this method may throw {@code IOException}. * * @param target - * The target of the link + * the target of the link * @param attrs - * The array of attributes to set atomically when creating the + * the array of attributes to set atomically when creating the * symbolic link * * @return this path * * @throws UnsupportedOperationException - * If the implementation does not support symbolic links or the + * if the implementation does not support symbolic links or the * array contains an attribute that cannot be set atomically when * creating the symbolic link * @throws FileAlreadyExistsException - * If a file with the name already exists (optional specific + * if a file with the name already exists (optional specific * exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the the default provider, and a security manager * is installed, it denies {@link LinkPermission}("symbolic") @@ -517,24 +518,24 @@ public abstract class Path * create hard links or to create links to directories. * * @param existing - * A reference to an existing file + * a reference to an existing file * * @return this path * * @throws UnsupportedOperationException - * If the implementation does not support adding an existing file + * if the implementation does not support adding an existing file * to a directory * @throws FileAlreadyExistsException - * If the entry could not otherwise be created because a file of + * if the entry could not otherwise be created because a file of * that name already exists (optional specific exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the the default provider, and a security manager * is installed, it denies {@link LinkPermission}("hard") * or its {@link SecurityManager#checkWrite(String) checkWrite} * method denies write access to both this path and the path of the - * existing file + * existing file. * * @see BasicFileAttributes#linkCount */ @@ -549,15 +550,15 @@ public abstract class Path * returned {@code Path} object will be associated with the same file * system as this {@code Path}. * - * @return A {@code Path} object representing the target of the link + * @return a {@code Path} object representing the target of the link * * @throws UnsupportedOperationException - * If the implementation does not support symbolic links + * if the implementation does not support symbolic links * @throws NotLinkException - * If the target could otherwise not be read because the file + * if the target could otherwise not be read because the file * is not a link (optional specific exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the the default provider, and a security manager * is installed, it checks that {@code FilePermission} has been @@ -605,13 +606,13 @@ public abstract class Path * A format for compound URIs is not defined in this release; such a scheme * may be added in a future release. * - * @return An absolute, hierarchical URI with a non-empty path component + * @return an absolute, hierarchical URI with a non-empty path component * * @throws IOError - * If an I/O error occurs obtaining the absolute path, or where a + * if an I/O error occurs obtaining the absolute path, or where a * file system is constructed to access the contents of a file as - * a file system, the URI of the enclosing file system cannot be - * obtained. + * a file system, and the URI of the enclosing file system cannot be + * obtained * * @throws SecurityException * In the case of the the default provider, and a security manager @@ -630,10 +631,10 @@ public abstract class Path * against a file system default directory. Depending on the implementation, * this method may throw an I/O error if the file system is not accessible. * - * @return A {@code Path} object representing the absolute path + * @return a {@code Path} object representing the absolute path * * @throws IOError - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the the default provider, and a security manager * is installed, its {@link SecurityManager#checkPropertyAccess(String) @@ -670,11 +671,11 @@ public abstract class Path * name is a symbolic link then the names are only removed if it guaranteed * that the resulting path will locate the same file as this path. * - * @return An absolute path represent the real path of the file + * @return an absolute path represent the real path of the file * located by this object * * @throws IOException - * If the file does not exist or an I/O error occurs + * if the file does not exist or an I/O error occurs * @throws SecurityException * In the case of the the default provider, and a security manager * is installed, its {@link SecurityManager#checkRead(String) checkRead} @@ -743,20 +744,20 @@ public abstract class Path * file system activities. * * @param target - * The target location + * the target location * @param options - * Options specifying how the copy should be done + * options specifying how the copy should be done * - * @return The target + * @return the target * * @throws UnsupportedOperationException - * If the array contains a copy option that is not supported + * if the array contains a copy option that is not supported * @throws FileAlreadyExistsException - * The target file exists and cannot be replaced because the + * if the target file exists and cannot be replaced because the * {@code REPLACE_EXISTING} option is not specified, or the target * file is a non-empty directory (optional specific exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkRead(String) checkRead} @@ -829,23 +830,23 @@ public abstract class Path * original file. * * @param target - * The target location + * the target location * @param options - * Options specifying how the move should be done + * options specifying how the move should be done * - * @return The target + * @return the target * * @throws UnsupportedOperationException - * If the array contains a copy option that is not supported + * if the array contains a copy option that is not supported * @throws FileAlreadyExistsException - * The target file exists and cannot be replaced because the + * if the target file exists and cannot be replaced because the * {@code REPLACE_EXISTING} option is not specified, or the target * file is a non-empty directory * @throws AtomicMoveNotSupportedException - * The options array contains the {@code ATOMIC_MOVE} option but + * if the options array contains the {@code ATOMIC_MOVE} option but * the file cannot be moved as an atomic file system operation. * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkWrite(String) checkWrite} @@ -875,13 +876,13 @@ public abstract class Path * directory that execute in a race-free manner then the returned directory * stream is a {@link SecureDirectoryStream}. * - * @return A new and open {@code DirectoryStream} object + * @return a new and open {@code DirectoryStream} object * * @throws NotDirectoryException - * If the file could not otherwise be opened because it is not + * if the file could not otherwise be opened because it is not * a directory (optional specific exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkRead(String) checkRead} @@ -920,19 +921,19 @@ public abstract class Path * stream is a {@link SecureDirectoryStream}. * * @param glob - * The glob pattern + * the glob pattern * - * @return A new and open {@code DirectoryStream} object + * @return a new and open {@code DirectoryStream} object * * @throws java.util.regex.PatternSyntaxException - * If the pattern is invalid + * if the pattern is invalid * @throws UnsupportedOperationException - * If the pattern syntax is not known to the implementation + * if the pattern syntax is not known to the implementation * @throws NotDirectoryException - * If the file could not otherwise be opened because it is not + * if the file could not otherwise be opened because it is not * a directory (optional specific exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkRead(String) checkRead} @@ -986,15 +987,15 @@ public abstract class Path * DirectoryStream<Path> stream = dir.newDirectoryStream(filter); * * @param filter - * The directory stream filter + * the directory stream filter * - * @return A new and open {@code DirectoryStream} object + * @return a new and open {@code DirectoryStream} object * * @throws NotDirectoryException - * If the file could not otherwise be opened because it is not + * if the file could not otherwise be opened because it is not * a directory (optional specific exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkRead(String) checkRead} @@ -1018,19 +1019,19 @@ public abstract class Path * occurrence is ignored. * * @param attrs - * An optional list of file attributes to set atomically when + * an optional list of file attributes to set atomically when * creating the file * - * @return This path + * @return this path * * @throws UnsupportedOperationException - * If the array contains an attribute that cannot be set atomically + * if the array contains an attribute that cannot be set atomically * when creating the file * @throws FileAlreadyExistsException - * If a file of that name already exists + * if a file of that name already exists * (optional specific exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkWrite(String) checkWrite} @@ -1053,19 +1054,19 @@ public abstract class Path * but the last occurrence is ignored. * * @param attrs - * An optional list of file attributes to set atomically when + * an optional list of file attributes to set atomically when * creating the directory * - * @return This path + * @return this path * * @throws UnsupportedOperationException - * If the array contains an attribute that cannot be set atomically + * if the array contains an attribute that cannot be set atomically * when creating the directory * @throws FileAlreadyExistsException - * If a directory could not otherwise be created because a file of + * if a directory could not otherwise be created because a file of * that name already exists (optional specific exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkWrite(String) checkWrite} @@ -1185,16 +1186,16 @@ public abstract class Path * @return a new seekable byte channel * * @throws IllegalArgumentException - * If the set contains an invalid combination of options + * if the set contains an invalid combination of options * @throws UnsupportedOperationException - * If an unsupported open option is specified or the array contains + * if an unsupported open option is specified or the array contains * attributes that cannot be set atomically when creating the file * @throws FileAlreadyExistsException - * If a file of that name already exists and the {@link + * if a file of that name already exists and the {@link * StandardOpenOption#CREATE_NEW CREATE_NEW} option is specified * (optional specific exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkRead(String) checkRead} @@ -1219,16 +1220,16 @@ public abstract class Path * FileChannel}. * * @param options - * Options specifying how the file is opened + * options specifying how the file is opened * * @return a new seekable byte channel * * @throws IllegalArgumentException - * If the set contains an invalid combination of options + * if the set contains an invalid combination of options * @throws UnsupportedOperationException - * If an unsupported open option is specified + * if an unsupported open option is specified * @throws FileAlreadyExistsException - * If a file of that name already exists and the {@link + * if a file of that name already exists and the {@link * StandardOpenOption#CREATE_NEW CREATE_NEW} option is specified * (optional specific exception) * @throws IOException {@inheritDoc} @@ -1245,10 +1246,10 @@ public abstract class Path * InputStream#reset reset} methods. The stream will be safe for access by * multiple concurrent threads. Reading commences at the beginning of the file. * - * @return An input stream to read bytes from the file + * @return an input stream to read bytes from the file * * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkRead(String) checkRead} @@ -1279,16 +1280,16 @@ public abstract class Path * * * @param options - * Options specifying how the file is opened + * options specifying how the file is opened * * @return a new seekable byte channel * * @throws IllegalArgumentException - * If {@code options} contains an invalid combination of options + * if {@code options} contains an invalid combination of options * @throws UnsupportedOperationException - * If an unsupported open option is specified + * if an unsupported open option is specified * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkWrite(String) checkWrite} @@ -1312,20 +1313,20 @@ public abstract class Path * for access by multiple concurrent threads. * * @param options - * Options specifying how the file is opened + * options specifying how the file is opened * @param attrs - * An optional list of file attributes to set atomically when + * an optional list of file attributes to set atomically when * creating the file * - * @return A new output stream + * @return a new output stream * * @throws IllegalArgumentException - * If the set contains an invalid combination of options + * if the set contains an invalid combination of options * @throws UnsupportedOperationException - * If an unsupported open option is specified or the array contains + * if an unsupported open option is specified or the array contains * attributes that cannot be set atomically when creating the file * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkWrite(String) checkWrite} @@ -1349,7 +1350,7 @@ public abstract class Path * @return {@code true} if the file is considered hidden * * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkRead(String) checkRead} @@ -1448,26 +1449,26 @@ public abstract class Path * on the existence of the link after it is registered. * * @param watcher - * The watch service to which this object is to be registered + * the watch service to which this object is to be registered * @param events - * The events for which this object should be registered + * the events for which this object should be registered * @param modifiers - * The modifiers, if any, that modify how the object is registered + * the modifiers, if any, that modify how the object is registered * - * @return A key representing the registration of this object with the + * @return a key representing the registration of this object with the * given watch service * * @throws UnsupportedOperationException - * If unsupported events or modifiers are specified + * if unsupported events or modifiers are specified * @throws IllegalArgumentException - * If an invalid combination of events or modifiers is specified + * if an invalid combination of events or modifiers is specified * @throws ClosedWatchServiceException - * If the watch service is closed + * if the watch service is closed * @throws NotDirectoryException - * If the file is registered to watch the entries in a directory + * if the file is registered to watch the entries in a directory * and the file is not a directory (optional specific exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkRead(String) checkRead} @@ -1537,7 +1538,7 @@ public abstract class Path * is the name of the file or directory denoted by this path. The {@link * #getRoot root} component, if present, is not returned by the iterator. * - * @return An iterator over the name elements of this path. + * @return an iterator over the name elements of this path. */ @Override public abstract Iterator iterator(); @@ -1550,9 +1551,9 @@ public abstract class Path * provider, platform specific. This method does not access the file system * and neither file is required to exist. * - * @param other The path compared to this path. + * @param other the path compared to this path. * - * @return Zero if the argument is {@link #equals equal} to this path, a + * @return zero if the argument is {@link #equals equal} to this path, a * value less than zero if this path is lexicographically less than * the argument, or a value greater than zero if this path is * lexicographically greater than the argument @@ -1574,14 +1575,14 @@ public abstract class Path *

This method satisfies the general contract of the {@link * java.lang.Object#equals(Object) Object.equals} method.

* - * @param ob - * The object to which this object is to be compared + * @param other + * the object to which this object is to be compared * * @return {@code true} if, and only if, the given object is a {@code Path} * that is identical to this {@code Path} */ @Override - public abstract boolean equals(Object ob); + public abstract boolean equals(Object other); /** * Computes a hash code for this path. @@ -1590,7 +1591,7 @@ public abstract class Path * satisfies the general contract of the {@link Object#hashCode * Object.hashCode} method. * - * @return The hash-code value for this Path + * @return the hash-code value for this path */ @Override public abstract int hashCode(); @@ -1605,7 +1606,7 @@ public abstract class Path *

The returned path string uses the default name {@link * FileSystem#getSeparator separator} to separate names in the path. * - * @return The string representation of this path + * @return the string representation of this path */ @Override public abstract String toString(); diff --git a/jdk/src/share/classes/java/nio/file/PathMatcher.java b/jdk/src/share/classes/java/nio/file/PathMatcher.java index 2266bc0cccf..5a1cfee88e6 100644 --- a/jdk/src/share/classes/java/nio/file/PathMatcher.java +++ b/jdk/src/share/classes/java/nio/file/PathMatcher.java @@ -40,7 +40,7 @@ public interface PathMatcher { * Tells if given path matches this matcher's pattern. * * @param path - * The path to match + * the path to match * * @return {@code true} if, and only if, the path matches this * matcher's pattern diff --git a/jdk/src/share/classes/java/nio/file/Paths.java b/jdk/src/share/classes/java/nio/file/Paths.java index 11a99db618e..2cd7a091213 100644 --- a/jdk/src/share/classes/java/nio/file/Paths.java +++ b/jdk/src/share/classes/java/nio/file/Paths.java @@ -45,13 +45,23 @@ public class Paths { * getPath} method of the {@link FileSystems#getDefault default} {@link * FileSystem}. * - * @param path - * The path string to convert + *

Note that while this method is very convenient, using it will + * imply an assumed reference to the default FileSystem and limit the + * utility of the calling code. Hence it should not be used in library code + * intended for flexible reuse. A more flexible alternative is to use an + * existing {@code Path} instance as an anchor, such as: + * 

+     *     Path dir = ...
+     *     Path path = dir.resolve("file");
+     *
* - * @return The resulting {@code Path} + * @param path + * the path string to convert + * + * @return the resulting {@code Path} * * @throws InvalidPathException - * If the path string cannot be converted to a {@code Path} + * if the path string cannot be converted to a {@code Path} * * @see FileSystem#getPath */ @@ -88,18 +98,18 @@ public class Paths { * provider specific and therefore unspecified. * * @param uri - * The URI to convert + * the URI to convert * - * @return The resulting {@code Path} + * @return the resulting {@code Path} * * @throws IllegalArgumentException - * If preconditions on the {@code uri} parameter do not hold. The + * if preconditions on the {@code uri} parameter do not hold. The * format of the URI is provider specific. * @throws FileSystemNotFoundException - * If the file system identified by the URI does not exist or the + * if the file system identified by the URI does not exist or the * provider identified by the URI's scheme component is not installed * @throws SecurityException - * If a security manager is installed and it denies an unspecified + * if a security manager is installed and it denies an unspecified * permission to access the file system */ public static Path get(URI uri) { diff --git a/jdk/src/share/classes/java/nio/file/ProviderMismatchException.java b/jdk/src/share/classes/java/nio/file/ProviderMismatchException.java index 7784913fe89..7c1bbc09762 100644 --- a/jdk/src/share/classes/java/nio/file/ProviderMismatchException.java +++ b/jdk/src/share/classes/java/nio/file/ProviderMismatchException.java @@ -45,7 +45,7 @@ public class ProviderMismatchException * Constructs an instance of this class. * * @param msg - * The detail message + * the detail message */ public ProviderMismatchException(String msg) { super(msg); diff --git a/jdk/src/share/classes/java/nio/file/ProviderNotFoundException.java b/jdk/src/share/classes/java/nio/file/ProviderNotFoundException.java index b659933eeca..dd1fee82dab 100644 --- a/jdk/src/share/classes/java/nio/file/ProviderNotFoundException.java +++ b/jdk/src/share/classes/java/nio/file/ProviderNotFoundException.java @@ -44,7 +44,7 @@ public class ProviderNotFoundException * Constructs an instance of this class. * * @param msg - * The detail message + * the detail message */ public ProviderNotFoundException(String msg) { super(msg); diff --git a/jdk/src/share/classes/java/nio/file/SecureDirectoryStream.java b/jdk/src/share/classes/java/nio/file/SecureDirectoryStream.java index e67e71711f5..11df095ceb3 100644 --- a/jdk/src/share/classes/java/nio/file/SecureDirectoryStream.java +++ b/jdk/src/share/classes/java/nio/file/SecureDirectoryStream.java @@ -91,21 +91,21 @@ public abstract class SecureDirectoryStream * effect upon newly created directory stream. * * @param path - * The path to the directory to open + * the path to the directory to open * @param followLinks * {@code true} if the links should be followed * @param filter - * The directory stream filter or {@code null}. + * the directory stream filter or {@code null}. * - * @return A new and open {@code SecureDirectoryStream} object + * @return a new and open {@code SecureDirectoryStream} object * * @throws ClosedDirectoryStreamException - * If the directory stream is closed + * if the directory stream is closed * @throws NotDirectoryException - * If the file could not otherwise be opened because it is not + * if the file could not otherwise be opened because it is not * a directory (optional specific exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkRead(String) checkRead} @@ -134,26 +134,26 @@ public abstract class SecureDirectoryStream * channel. * * @param path - * The path of the file to open open or create + * the path of the file to open open or create * @param options - * Options specifying how the file is opened + * options specifying how the file is opened * @param attrs - * An optional list of attributes to set atomically when creating + * an optional list of attributes to set atomically when creating * the file * * @throws ClosedDirectoryStreamException - * If the directory stream is closed + * if the directory stream is closed * @throws IllegalArgumentException - * If the set contains an invalid combination of options + * if the set contains an invalid combination of options * @throws UnsupportedOperationException - * If an unsupported open option is specified or the array contains + * if an unsupported open option is specified or the array contains * attributes that cannot be set atomically when creating the file * @throws FileAlreadyExistsException - * If a file of that name already exists and the {@link + * if a file of that name already exists and the {@link * StandardOpenOption#CREATE_NEW CREATE_NEW} option is specified * (optional specific exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkRead(String) checkRead} @@ -178,14 +178,14 @@ public abstract class SecureDirectoryStream * relative path then the file to delete is relative to this open directory. * * @param path - * The path of the file to delete + * the path of the file to delete * * @throws ClosedDirectoryStreamException - * If the directory stream is closed + * if the directory stream is closed * @throws NoSuchFileException - * If the the file does not exist (optional specific exception) + * if the file does not exist (optional specific exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkDelete(String) checkDelete} @@ -203,17 +203,17 @@ public abstract class SecureDirectoryStream * directory to delete is relative to this open directory. * * @param path - * The path of the directory to delete + * the path of the directory to delete * * @throws ClosedDirectoryStreamException - * If the directory stream is closed + * if the directory stream is closed * @throws NoSuchFileException - * If the the directory does not exist (optional specific exception) + * if the the directory does not exist (optional specific exception) * @throws DirectoryNotEmptyException - * If the directory could not otherwise be deleted because it is + * if the directory could not otherwise be deleted because it is * not empty (optional specific exception) * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkDelete(String) checkDelete} @@ -238,21 +238,21 @@ public abstract class SecureDirectoryStream * method fails. * * @param srcpath - * The name of the file to move + * the name of the file to move * @param targetdir - * The destination directory + * the destination directory * @param targetpath - * The name to give the file in the destination directory + * the name to give the file in the destination directory * * @throws ClosedDirectoryStreamException - * If this or the target directory stream is closed + * if this or the target directory stream is closed * @throws FileAlreadyExistsException - * The file already exists in the target directory and cannot + * if the file already exists in the target directory and cannot * be replaced (optional specific exception) * @throws AtomicMoveNotSupportedException - * The file cannot be moved as an atomic file system operation + * if the file cannot be moved as an atomic file system operation * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, the {@link SecurityManager#checkWrite(String) checkWrite} @@ -279,9 +279,9 @@ public abstract class SecureDirectoryStream * ClosedDirectoryStreamException ClosedDirectoryStreamException}. * * @param type - * The {@code Class} object corresponding to the file attribute view + * the {@code Class} object corresponding to the file attribute view * - * @return A new file attribute view of the specified type bound to + * @return a new file attribute view of the specified type bound to * this directory stream, or {@code null} if the attribute view * type is not available */ @@ -307,13 +307,13 @@ public abstract class SecureDirectoryStream * fail when invoked and the file does not exist. * * @param path - * The path of the file + * the path of the file * @param type - * The {@code Class} object corresponding to the file attribute view + * the {@code Class} object corresponding to the file attribute view * @param options - * Options indicating how symbolic links are handled + * options indicating how symbolic links are handled * - * @return A new file attribute view of the specified type bound to a + * @return a new file attribute view of the specified type bound to a * this directory stream, or {@code null} if the attribute view * type is not available * diff --git a/jdk/src/share/classes/java/nio/file/SimpleFileVisitor.java b/jdk/src/share/classes/java/nio/file/SimpleFileVisitor.java index 99308dc485b..d9557d024a4 100644 --- a/jdk/src/share/classes/java/nio/file/SimpleFileVisitor.java +++ b/jdk/src/share/classes/java/nio/file/SimpleFileVisitor.java @@ -65,7 +65,7 @@ public class SimpleFileVisitor implements FileVisitor { * exception as cause. * * @throws IOError - * With the I/O exception thrown when the attempt to open the + * with the I/O exception thrown when the attempt to open the * directory failed */ @Override @@ -91,7 +91,7 @@ public class SimpleFileVisitor implements FileVisitor { * exception as cause. * * @throws IOError - * With the I/O exception thrown when the attempt to read the file + * with the I/O exception thrown when the attempt to read the file * attributes failed */ @Override @@ -109,7 +109,7 @@ public class SimpleFileVisitor implements FileVisitor { * cause. * * @throws IOError - * If iteration of the directory completed prematurely due to an + * if iteration of the directory completed prematurely due to an * I/O error */ @Override diff --git a/jdk/src/share/classes/java/nio/file/WatchEvent.java b/jdk/src/share/classes/java/nio/file/WatchEvent.java index 1f929d0e103..296efd44377 100644 --- a/jdk/src/share/classes/java/nio/file/WatchEvent.java +++ b/jdk/src/share/classes/java/nio/file/WatchEvent.java @@ -88,7 +88,7 @@ public abstract class WatchEvent { /** * Returns the event kind. * - * @return The event kind + * @return the event kind */ public abstract Kind kind(); @@ -96,7 +96,7 @@ public abstract class WatchEvent { * Returns the event count. If the event count is greater than {@code 1} * then this is a repeated event. * - * @return The event count + * @return the event count */ public abstract int count(); @@ -110,7 +110,7 @@ public abstract class WatchEvent { * the directory registered with the watch service, and the entry that is * created, deleted, or modified. * - * @return The event context; may be {@code null} + * @return the event context; may be {@code null} */ public abstract T context(); } diff --git a/jdk/src/share/classes/java/nio/file/WatchKey.java b/jdk/src/share/classes/java/nio/file/WatchKey.java index 11fb5225902..d065585d87d 100644 --- a/jdk/src/share/classes/java/nio/file/WatchKey.java +++ b/jdk/src/share/classes/java/nio/file/WatchKey.java @@ -103,7 +103,7 @@ public abstract class WatchKey { * *

Note that this method does not wait if there are no events pending. * - * @return The list of the events retrieved + * @return the list of the events retrieved */ public abstract List> pollEvents(); @@ -117,7 +117,7 @@ public abstract class WatchKey { * events then the watch key is put into the ready state and will remain in * that state until an event is detected or the watch key is cancelled. * - * @return {@code true} if the watch key is valid and has been reset; + * @return {@code true} if the watch key is valid and has been reset, and * {@code false} if the watch key could not be reset because it is * no longer {@link #isValid valid} */ diff --git a/jdk/src/share/classes/java/nio/file/WatchService.java b/jdk/src/share/classes/java/nio/file/WatchService.java index bc83a9801cd..52678df79b6 100644 --- a/jdk/src/share/classes/java/nio/file/WatchService.java +++ b/jdk/src/share/classes/java/nio/file/WatchService.java @@ -126,7 +126,7 @@ public abstract class WatchService * has no effect. * * @throws IOException - * If an I/O error occurs + * if an I/O error occurs */ @Override public abstract void close() throws IOException; @@ -135,10 +135,10 @@ public abstract class WatchService * Retrieves and removes the next watch key, or {@code null} if none are * present. * - * @return The next watch key, or {@code null} + * @return the next watch key, or {@code null} * * @throws ClosedWatchServiceException - * If this watch service is closed + * if this watch service is closed */ public abstract WatchKey poll(); @@ -152,13 +152,13 @@ public abstract class WatchService * a {@code TimeUnit} determining how to interpret the timeout * parameter * - * @return The next watch key, or {@code null} + * @return the next watch key, or {@code null} * * @throws ClosedWatchServiceException - * If this watch service is closed, or it is closed while waiting + * if this watch service is closed, or it is closed while waiting * for the next key * @throws InterruptedException - * If interrupted while waiting + * if interrupted while waiting */ public abstract WatchKey poll(long timeout, TimeUnit unit) throws InterruptedException; @@ -166,13 +166,13 @@ public abstract class WatchService /** * Retrieves and removes next watch key, waiting if none are yet present. * - * @return The next watch key + * @return the next watch key * * @throws ClosedWatchServiceException - * If this watch service is closed, or it is closed while waiting + * if this watch service is closed, or it is closed while waiting * for the next key * @throws InterruptedException - * If interrupted while waiting + * if interrupted while waiting */ public abstract WatchKey take() throws InterruptedException; } diff --git a/jdk/src/share/classes/java/nio/file/Watchable.java b/jdk/src/share/classes/java/nio/file/Watchable.java index c30e50d03a1..9bfa627f7bc 100644 --- a/jdk/src/share/classes/java/nio/file/Watchable.java +++ b/jdk/src/share/classes/java/nio/file/Watchable.java @@ -64,25 +64,25 @@ public interface Watchable { * support. * * @param watcher - * The watch service to which this object is to be registered + * the watch service to which this object is to be registered * @param events - * The events for which this object should be registered + * the events for which this object should be registered * @param modifiers - * The modifiers, if any, that modify how the object is registered + * the modifiers, if any, that modify how the object is registered * - * @return A key representing the registration of this object with the + * @return a key representing the registration of this object with the * given watch service * * @throws UnsupportedOperationException - * If unsupported events or modifiers are specified + * if unsupported events or modifiers are specified * @throws IllegalArgumentException - * If an invalid of combination of events are modifiers are specified + * if an invalid of combination of events are modifiers are specified * @throws ClosedWatchServiceException - * If the watch service is closed + * if the watch service is closed * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException - * If a security manager is installed and it denies an unspecified + * if a security manager is installed and it denies an unspecified * permission required to monitor this object. Implementations of * this interface should specify the permission checks. */ @@ -102,23 +102,23 @@ public interface Watchable { * * * @param watcher - * The watch service to which this object is to be registered + * the watch service to which this object is to be registered * @param events - * The events for which this object should be registered + * the events for which this object should be registered * - * @return A key representing the registration of this object with the + * @return a key representing the registration of this object with the * given watch service * * @throws UnsupportedOperationException - * If unsupported events are specified + * if unsupported events are specified * @throws IllegalArgumentException - * If an invalid of combination of events are specified + * if an invalid of combination of events are specified * @throws ClosedWatchServiceException - * If the watch service is closed + * if the watch service is closed * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException - * If a security manager is installed and it denies an unspecified + * if a security manager is installed and it denies an unspecified * permission required to monitor this object. Implementations of * this interface should specify the permission checks. */ diff --git a/jdk/src/share/classes/java/nio/file/attribute/AclEntry.java b/jdk/src/share/classes/java/nio/file/attribute/AclEntry.java index b1e3af82246..817e1b04742 100644 --- a/jdk/src/share/classes/java/nio/file/attribute/AclEntry.java +++ b/jdk/src/share/classes/java/nio/file/attribute/AclEntry.java @@ -118,10 +118,10 @@ public final class AclEntry { * The type and who components are required to have been set in order * to construct an {@code AclEntry}. * - * @return A new ACL entry + * @return a new ACL entry * * @throws IllegalStateException - * If the type or who component have not been set. + * if the type or who component have not been set */ public AclEntry build() { if (type == null) @@ -134,7 +134,7 @@ public final class AclEntry { /** * Sets the type component of this builder. * - * @return This builder + * @return this builder */ public Builder setType(AclEntryType type) { if (type == null) @@ -146,7 +146,7 @@ public final class AclEntry { /** * Sets the principal component of this builder. * - * @return This builder + * @return this builder */ public Builder setPrincipal(UserPrincipal who) { if (who == null) @@ -168,10 +168,10 @@ public final class AclEntry { * Sets the permissions component of this builder. On return, the * permissions component of this builder is a copy of the given set. * - * @return This builder + * @return this builder * * @throws ClassCastException - * If the sets contains elements that are not of type {@code + * if the set contains elements that are not of type {@code * AclEntryPermission} */ public Builder setPermissions(Set perms) { @@ -187,7 +187,7 @@ public final class AclEntry { * permissions component of this builder is a copy of the permissions in * the given array. * - * @return This builder + * @return this builder */ public Builder setPermissions(AclEntryPermission... perms) { Set set = @@ -206,10 +206,10 @@ public final class AclEntry { * Sets the flags component of this builder. On return, the flags * component of this builder is a copy of the given set. * - * @return This builder + * @return this builder * * @throws ClassCastException - * If the sets contains elements that are not of type {@code + * if the set contains elements that are not of type {@code * AclEntryFlag} */ public Builder setFlags(Set flags) { @@ -225,7 +225,7 @@ public final class AclEntry { * component of this builder is a copy of the flags in the given * array. * - * @return This builder + * @return this builder */ public Builder setFlags(AclEntryFlag... flags) { Set set = new HashSet(flags.length); @@ -245,7 +245,7 @@ public final class AclEntry { * components is {@code null}. The initial value of the permissions and * flags components is the empty set. * - * @return A new builder + * @return a new builder */ public static Builder newBuilder() { Set perms = Collections.emptySet(); @@ -257,9 +257,9 @@ public final class AclEntry { * Constructs a new builder with the components of an existing ACL entry. * * @param entry - * An ACL entry + * an ACL entry * - * @return A new builder + * @return a new builder */ public static Builder newBuilder(AclEntry entry) { return new Builder(entry.type, entry.who, entry.perms, entry.flags); @@ -310,7 +310,7 @@ public final class AclEntry { *

This method satisfies the general contract of the {@link * java.lang.Object#equals(Object) Object.equals} method.

* - * @param ob The object to which this object is to be compared + * @param ob the object to which this object is to be compared * * @return {@code true} if, and only if, the given object is an AclEntry that * is identical to this AclEntry @@ -341,7 +341,7 @@ public final class AclEntry { * Returns the hash-code value for this ACL entry. * *

This method satisfies the general contract of the {@link - * Object#hashCode method}. + * Object#hashCode} method. */ @Override public int hashCode() { @@ -359,7 +359,7 @@ public final class AclEntry { /** * Returns the string representation of this ACL entry. * - * @return The string representation of this entry + * @return the string representation of this entry */ @Override public String toString() { diff --git a/jdk/src/share/classes/java/nio/file/attribute/AclFileAttributeView.java b/jdk/src/share/classes/java/nio/file/attribute/AclFileAttributeView.java index 3582dde77c6..c3d28c914a7 100644 --- a/jdk/src/share/classes/java/nio/file/attribute/AclFileAttributeView.java +++ b/jdk/src/share/classes/java/nio/file/attribute/AclFileAttributeView.java @@ -160,11 +160,11 @@ public interface AclFileAttributeView * existing ACL. The {@link #setAcl setAcl} method is used to update * the file's ACL attribute. * - * @return An ordered list of {@link AclEntry entries} representing the + * @return an ordered list of {@link AclEntry entries} representing the * ACL * * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, a security manager is * installed, and it denies {@link RuntimePermission}("accessUserInformation") @@ -197,10 +197,10 @@ public interface AclFileAttributeView * may also cause these security related attributes to be updated. * * @param acl - * The new access control list + * the new access control list * * @throws IOException - * If an I/O error occurs or the ACL is invalid + * if an I/O error occurs or the ACL is invalid * @throws SecurityException * In the case of the default provider, a security manager is * installed, it denies {@link RuntimePermission}("accessUserInformation") diff --git a/jdk/src/share/classes/java/nio/file/attribute/AttributeView.java b/jdk/src/share/classes/java/nio/file/attribute/AttributeView.java index 1d768711d9c..6b0934e7af0 100644 --- a/jdk/src/share/classes/java/nio/file/attribute/AttributeView.java +++ b/jdk/src/share/classes/java/nio/file/attribute/AttributeView.java @@ -53,15 +53,15 @@ public interface AttributeView { * Reads the value of an attribute. * * @param attribute - * The attribute name (case sensitive) + * the attribute name (case sensitive) * - * @return The value of the attribute, or {@code null} if the attribute is + * @return the value of the attribute, or {@code null} if the attribute is * not supported * * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException - * If a security manager is set and it denies access + * if a security manager is set and it denies access */ Object getAttribute(String attribute) throws IOException; @@ -69,24 +69,24 @@ public interface AttributeView { * Sets/updates the value of an attribute. * * @param attribute - * The attribute name (case sensitive) + * the attribute name (case sensitive) * @param value - * The attribute value + * the attribute value * * @throws UnsupportedOperationException - * If the attribute is not supported or this attribute view does + * if the attribute is not supported or this attribute view does * not support updating the value of the attribute * @throws IllegalArgumentException - * If the attribute value is of the correct type but has an + * if the attribute value is of the correct type but has an * inappropriate value * @throws ClassCastException - * If the attribute value is not of the expected type or is a + * if the attribute value is not of the expected type or is a * collection containing elements that are not of the expected * type * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException - * If a security manager is set and it denies access + * if a security manager is set and it denies access */ void setAttribute(String attribute, Object value) throws IOException; @@ -102,17 +102,17 @@ public interface AttributeView { * to other file system operations. * * @param first - * The name of an attribute to read (case sensitive) + * the name of an attribute to read (case sensitive) * @param rest - * The names of others attributes to read (case sensitive) + * the names of other attributes to read (case sensitive) * - * @return An unmodifiable map of the attributes; may be empty. Its keys are + * @return an unmodifiable map of the attributes; may be empty. Its keys are * the attribute names, its values are the attribute values * * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException - * If a security manager is set and it denies access + * if a security manager is set and it denies access */ Map readAttributes(String first, String... rest) throws IOException; } diff --git a/jdk/src/share/classes/java/nio/file/attribute/BasicFileAttributeView.java b/jdk/src/share/classes/java/nio/file/attribute/BasicFileAttributeView.java index 80fccb4e4ae..70100834d8f 100644 --- a/jdk/src/share/classes/java/nio/file/attribute/BasicFileAttributeView.java +++ b/jdk/src/share/classes/java/nio/file/attribute/BasicFileAttributeView.java @@ -125,10 +125,10 @@ public interface BasicFileAttributeView *

It is implementation specific if all file attributes are read as an * atomic operation with respect to other file system operations. * - * @return The file attributes + * @return the file attributes * * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, a security manager is * installed, its {@link SecurityManager#checkRead(String) checkRead} @@ -158,22 +158,22 @@ public interface BasicFileAttributeView * this method has no effect. * * @param lastModifiedTime - * The new last modified time, or {@code -1L} to update it to + * the new last modified time, or {@code -1L} to update it to * the current time, or {@code null} to not change the attribute * @param lastAccessTime - * The last access time, or {@code -1L} to update it to + * the last access time, or {@code -1L} to update it to * the current time, or {@code null} to not change the attribute. * @param createTime - * The file's create time, or {@code -1L} to update it to + * the file's create time, or {@code -1L} to update it to * the current time, or {@code null} to not change the attribute * @param unit - * A {@code TimeUnit} determining how to interpret the time values + * a {@code TimeUnit} determining how to interpret the time values * * @throws IllegalArgumentException - * If any of the parameters is a negative value other than {@code + * if any of the parameters is a negative value other than {@code * -1L} * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, a security manager is * installed, its {@link SecurityManager#checkWrite(String) checkWrite} diff --git a/jdk/src/share/classes/java/nio/file/attribute/BasicFileAttributes.java b/jdk/src/share/classes/java/nio/file/attribute/BasicFileAttributes.java index 65c3a25f90f..64c163bc5a1 100644 --- a/jdk/src/share/classes/java/nio/file/attribute/BasicFileAttributes.java +++ b/jdk/src/share/classes/java/nio/file/attribute/BasicFileAttributes.java @@ -53,7 +53,7 @@ public interface BasicFileAttributes { *

The {@link #resolution() resolution} method returns the {@link TimeUnit} * to interpret the return value of this method. * - * @return A long value representing the time the file was + * @return a long value representing the time the file was * last modified since the epoch (00:00:00 GMT, January 1, 1970), * or {@code -1L} if the attribute is not supported. */ @@ -65,7 +65,7 @@ public interface BasicFileAttributes { *

The {@link #resolution() resolution} method returns the {@link TimeUnit} * to interpret the return value of this method. * - * @return A long value representing the time of last access + * @return a long value representing the time of last access * since the epoch (00:00:00 GMT, January 1, 1970), or {@code -1L} * if the attribute is not supported. */ @@ -78,7 +78,7 @@ public interface BasicFileAttributes { *

The {@link #resolution() resolution} method returns the {@link TimeUnit} * to interpret the return value of this method. * - * @return A long value representing the time the file was + * @return a long value representing the time the file was * created since the epoch (00:00:00 GMT, January 1, 1970), or * {@code -1L} if the attribute is not supported. */ @@ -88,7 +88,7 @@ public interface BasicFileAttributes { * Returns the {@link TimeUnit} required to interpret the time of last * modification, time of last access, and creation time. * - * @return The {@code TimeUnit} required to interpret the file time stamps + * @return the {@code TimeUnit} required to interpret the file time stamps */ TimeUnit resolution(); @@ -120,7 +120,7 @@ public interface BasicFileAttributes { * #isRegularFile regular} files is implementation specific and * therefore unspecified. * - * @return The file size, in bytes + * @return the file size, in bytes */ long size(); diff --git a/jdk/src/share/classes/java/nio/file/attribute/DosFileAttributeView.java b/jdk/src/share/classes/java/nio/file/attribute/DosFileAttributeView.java index ca7fca5d21f..c57683999b6 100644 --- a/jdk/src/share/classes/java/nio/file/attribute/DosFileAttributeView.java +++ b/jdk/src/share/classes/java/nio/file/attribute/DosFileAttributeView.java @@ -106,10 +106,10 @@ public interface DosFileAttributeView * the DOS attribute in order to update this attribute. * * @param value - * The new value of the attribute + * the new value of the attribute * * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default, and a security manager is installed, * its {@link SecurityManager#checkWrite(String) checkWrite} method @@ -126,10 +126,10 @@ public interface DosFileAttributeView * the DOS attribute in order to update this attribute. * * @param value - * The new value of the attribute + * the new value of the attribute * * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default, and a security manager is installed, * its {@link SecurityManager#checkWrite(String) checkWrite} method @@ -146,10 +146,10 @@ public interface DosFileAttributeView * the DOS attribute in order to update this attribute. * * @param value - * The new value of the attribute + * the new value of the attribute * * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default, and a security manager is installed, * its {@link SecurityManager#checkWrite(String) checkWrite} method @@ -166,10 +166,10 @@ public interface DosFileAttributeView * the DOS attribute in order to update this attribute. * * @param value - * The new value of the attribute + * the new value of the attribute * * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default, and a security manager is installed, * its {@link SecurityManager#checkWrite(String) checkWrite} method diff --git a/jdk/src/share/classes/java/nio/file/attribute/DosFileAttributes.java b/jdk/src/share/classes/java/nio/file/attribute/DosFileAttributes.java index 63de2ddc502..53e63d51a98 100644 --- a/jdk/src/share/classes/java/nio/file/attribute/DosFileAttributes.java +++ b/jdk/src/share/classes/java/nio/file/attribute/DosFileAttributes.java @@ -49,7 +49,7 @@ public interface DosFileAttributes * or platform does any enforcement to prevent read-only files * from being updated is implementation specific. * - * @return The value of the read-only attribute. + * @return the value of the read-only attribute */ boolean isReadOnly(); @@ -59,7 +59,7 @@ public interface DosFileAttributes *

This attribute is often used to indicate if the file is visible to * users. * - * @return The value of the hidden attribute. + * @return the value of the hidden attribute */ boolean isHidden(); @@ -68,7 +68,7 @@ public interface DosFileAttributes * *

This attribute is typically used by backup programs. * - * @return The value of the archive attribute. + * @return the value of the archive attribute */ boolean isArchive(); @@ -78,7 +78,7 @@ public interface DosFileAttributes *

This attribute is often used to indicate that the file is a component * of the operating system. * - * @return The value of the system attribute. + * @return the value of the system attribute */ boolean isSystem(); } diff --git a/jdk/src/share/classes/java/nio/file/attribute/FileOwnerAttributeView.java b/jdk/src/share/classes/java/nio/file/attribute/FileOwnerAttributeView.java index 8c176430d46..0afc19efbff 100644 --- a/jdk/src/share/classes/java/nio/file/attribute/FileOwnerAttributeView.java +++ b/jdk/src/share/classes/java/nio/file/attribute/FileOwnerAttributeView.java @@ -65,7 +65,7 @@ public interface FileOwnerAttributeView * @return the file owner * * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, a security manager is * installed, and it denies {@link @@ -84,10 +84,10 @@ public interface FileOwnerAttributeView * to set the file owner to a user principal that is not a group. * * @param owner - * The new file owner + * the new file owner * * @throws IOException - * If an I/O error occurs, or the {@code owner} parameter is a + * if an I/O error occurs, or the {@code owner} parameter is a * group and this implementation does not support setting the owner * to a group * @throws SecurityException diff --git a/jdk/src/share/classes/java/nio/file/attribute/PosixFileAttributeView.java b/jdk/src/share/classes/java/nio/file/attribute/PosixFileAttributeView.java index fdd81f03a7c..285b8bb7d1c 100644 --- a/jdk/src/share/classes/java/nio/file/attribute/PosixFileAttributeView.java +++ b/jdk/src/share/classes/java/nio/file/attribute/PosixFileAttributeView.java @@ -163,13 +163,13 @@ public interface PosixFileAttributeView * Updates the file permissions. * * @param perms - * The new set of permissions + * the new set of permissions * * @throws ClassCastException - * If the sets contains elements that are not of type {@code + * if the sets contains elements that are not of type {@code * PosixFilePermission} * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, a security manager is * installed, and it denies {@link RuntimePermission}("accessUserInformation") @@ -182,10 +182,10 @@ public interface PosixFileAttributeView * Updates the file group-owner. * * @param group - * The new file group-owner - + * the new file group-owner + * * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, it denies {@link RuntimePermission}("accessUserInformation") diff --git a/jdk/src/share/classes/java/nio/file/attribute/PosixFileAttributes.java b/jdk/src/share/classes/java/nio/file/attribute/PosixFileAttributes.java index 62801edd95a..c09aa9db37c 100644 --- a/jdk/src/share/classes/java/nio/file/attribute/PosixFileAttributes.java +++ b/jdk/src/share/classes/java/nio/file/attribute/PosixFileAttributes.java @@ -47,7 +47,7 @@ public interface PosixFileAttributes /** * Returns the owner of the file. * - * @return The file owner + * @return the file owner * * @see PosixFileAttributeView#setOwner */ @@ -56,7 +56,7 @@ public interface PosixFileAttributes /** * Returns the group owner of the file. * - * @return The file group owner + * @return the file group owner * * @see PosixFileAttributeView#setGroup */ @@ -69,7 +69,7 @@ public interface PosixFileAttributes * to be modified and passed to the {@link PosixFileAttributeView#setPermissions * setPermissions} method to update the file's permissions. * - * @return The file permissions + * @return the file permissions * * @see PosixFileAttributeView#setPermissions */ diff --git a/jdk/src/share/classes/java/nio/file/attribute/PosixFilePermissions.java b/jdk/src/share/classes/java/nio/file/attribute/PosixFilePermissions.java index 5214cfb7553..97d322c6a59 100644 --- a/jdk/src/share/classes/java/nio/file/attribute/PosixFilePermissions.java +++ b/jdk/src/share/classes/java/nio/file/attribute/PosixFilePermissions.java @@ -64,9 +64,9 @@ public class PosixFilePermissions { * {@code PosixFilePermission} then these elements are ignored. * * @param perms - * The set of permissions + * the set of permissions * - * @return The string representation of the permission set + * @return the string representation of the permission set * * @see #fromString */ @@ -114,12 +114,12 @@ public class PosixFilePermissions { * * * @param perms - * String representing a set of permissions + * string representing a set of permissions * - * @return The resulting set of permissions + * @return the resulting set of permissions * * @throws IllegalArgumentException - * If the string cannot be converted to a set of permissions + * if the string cannot be converted to a set of permissions * * @see #toString(Set) */ @@ -146,13 +146,13 @@ public class PosixFilePermissions { * methods. * * @param perms - * The set of permissions + * the set of permissions * - * @return An attribute encapsulating the given file permissions with + * @return an attribute encapsulating the given file permissions with * {@link FileAttribute#name name} {@code "posix:permissions"} * * @throws ClassCastException - * If the sets contains elements that are not of type {@code + * if the set contains elements that are not of type {@code * PosixFilePermission} */ public static FileAttribute> diff --git a/jdk/src/share/classes/java/nio/file/attribute/UserPrincipalLookupService.java b/jdk/src/share/classes/java/nio/file/attribute/UserPrincipalLookupService.java index 9395445b491..ba74882ce67 100644 --- a/jdk/src/share/classes/java/nio/file/attribute/UserPrincipalLookupService.java +++ b/jdk/src/share/classes/java/nio/file/attribute/UserPrincipalLookupService.java @@ -62,14 +62,14 @@ public abstract class UserPrincipalLookupService { * Lookup a user principal by name. * * @param name - * The string representation of the user principal to lookup + * the string representation of the user principal to lookup * - * @return A user principal + * @return a user principal * * @throws UserPrincipalNotFoundException - * The principal does not exist + * the principal does not exist * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, it checks {@link RuntimePermission}("lookupUserInformation") @@ -87,14 +87,14 @@ public abstract class UserPrincipalLookupService { * lookupPrincipalByName}. * * @param group - * The string representation of the group to lookup + * the string representation of the group to lookup * - * @return A user principal. + * @return a user principal * * @throws UserPrincipalNotFoundException - * The principal does not exist or is not a group + * the principal does not exist or is not a group * @throws IOException - * If an I/O error occurs + * if an I/O error occurs * @throws SecurityException * In the case of the default provider, and a security manager is * installed, it checks {@link RuntimePermission}("lookupUserInformation") diff --git a/jdk/src/share/classes/java/nio/file/attribute/UserPrincipalNotFoundException.java b/jdk/src/share/classes/java/nio/file/attribute/UserPrincipalNotFoundException.java index dd3b4fb7a53..94cc88ba20a 100644 --- a/jdk/src/share/classes/java/nio/file/attribute/UserPrincipalNotFoundException.java +++ b/jdk/src/share/classes/java/nio/file/attribute/UserPrincipalNotFoundException.java @@ -45,7 +45,7 @@ public class UserPrincipalNotFoundException * Constructs an instance of this class. * * @param name - * The principal name; may be {@code null} + * the principal name; may be {@code null} */ public UserPrincipalNotFoundException(String name) { super(); @@ -56,7 +56,7 @@ public class UserPrincipalNotFoundException * Returns the user principal name if this exception was created with the * user principal name that was not found, otherwise null. * - * @return The user principal name or {@code null} + * @return the user principal name or {@code null} */ public String getName() { return name; diff --git a/jdk/src/share/classes/java/nio/file/package-info.java b/jdk/src/share/classes/java/nio/file/package-info.java index 4210b79365f..3623ebe12cd 100644 --- a/jdk/src/share/classes/java/nio/file/package-info.java +++ b/jdk/src/share/classes/java/nio/file/package-info.java @@ -24,7 +24,7 @@ */ /** - * Define interfaces and classes for the Java virtual machine to access files, + * Defines interfaces and classes for the Java virtual machine to access files, * file attributes, and file systems. * *

The java.nio.file package defines classes to access files and file