Apache
/
hadoop
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HADOOP-11786. Fix Javadoc typos in org.apache.hadoop.fs.FileSystem. Contributed by Andras Bokor.

This commit is contained in:
Anu Engineer 2016-08-17 14:58:50 -07:00
parent 822d661b8f
commit c57523163f
1 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/FileSystem.java
View File

@ -934,13 +934,13 @@ public abstract class FileSystem extends Configured implements Closeable {
* Create an FSDataOutputStream at the indicated Path with write-progress * Create an FSDataOutputStream at the indicated Path with write-progress
* reporting. * reporting.
* @param f the file name to open * @param f the file name to open
* @param permission * @param permission file permission
* @param overwrite if a file with this name already exists, then if true, * @param overwrite if a file with this name already exists, then if true,
* the file will be overwritten, and if false an error will be thrown. * the file will be overwritten, and if false an error will be thrown.
* @param bufferSize the size of the buffer to be used. * @param bufferSize the size of the buffer to be used.
* @param replication required block replication for the file. * @param replication required block replication for the file.
* @param blockSize * @param blockSize block size
* @param progress * @param progress the progress reporter
* @throws IOException * @throws IOException
* @see #setPermission(Path, FsPermission) * @see #setPermission(Path, FsPermission)
*/ */
@ -956,12 +956,12 @@ public abstract class FileSystem extends Configured implements Closeable {
* Create an FSDataOutputStream at the indicated Path with write-progress * Create an FSDataOutputStream at the indicated Path with write-progress
* reporting. * reporting.
* @param f the file name to open * @param f the file name to open
* @param permission * @param permission file permission
* @param flags {@link CreateFlag}s to use for this stream. * @param flags {@link CreateFlag}s to use for this stream.
* @param bufferSize the size of the buffer to be used. * @param bufferSize the size of the buffer to be used.
* @param replication required block replication for the file. * @param replication required block replication for the file.
* @param blockSize * @param blockSize block size
* @param progress * @param progress the progress reporter
* @throws IOException * @throws IOException
* @see #setPermission(Path, FsPermission) * @see #setPermission(Path, FsPermission)
*/ */
@ -980,12 +980,12 @@ public abstract class FileSystem extends Configured implements Closeable {
* Create an FSDataOutputStream at the indicated Path with a custom * Create an FSDataOutputStream at the indicated Path with a custom
* checksum option * checksum option
* @param f the file name to open * @param f the file name to open
* @param permission * @param permission file permission
* @param flags {@link CreateFlag}s to use for this stream. * @param flags {@link CreateFlag}s to use for this stream.
* @param bufferSize the size of the buffer to be used. * @param bufferSize the size of the buffer to be used.
* @param replication required block replication for the file. * @param replication required block replication for the file.
* @param blockSize * @param blockSize block size
* @param progress * @param progress the progress reporter
* @param checksumOpt checksum parameter. If null, the values * @param checksumOpt checksum parameter. If null, the values
* found in conf will be used. * found in conf will be used.
* @throws IOException * @throws IOException
@ -1094,8 +1094,8 @@ public abstract class FileSystem extends Configured implements Closeable {
* the file will be overwritten, and if false an error will be thrown. * the file will be overwritten, and if false an error will be thrown.
* @param bufferSize the size of the buffer to be used. * @param bufferSize the size of the buffer to be used.
* @param replication required block replication for the file. * @param replication required block replication for the file.
* @param blockSize * @param blockSize block size
* @param progress * @param progress the progress reporter
* @throws IOException * @throws IOException
* @see #setPermission(Path, FsPermission) * @see #setPermission(Path, FsPermission)
*/ */
@ -1112,13 +1112,13 @@ public abstract class FileSystem extends Configured implements Closeable {
* reporting. Same as create(), except fails if parent directory doesn't * reporting. Same as create(), except fails if parent directory doesn't
* already exist. * already exist.
* @param f the file name to open * @param f the file name to open
* @param permission * @param permission file permission
* @param overwrite if a file with this name already exists, then if true, * @param overwrite if a file with this name already exists, then if true,
* the file will be overwritten, and if false an error will be thrown. * the file will be overwritten, and if false an error will be thrown.
* @param bufferSize the size of the buffer to be used. * @param bufferSize the size of the buffer to be used.
* @param replication required block replication for the file. * @param replication required block replication for the file.
* @param blockSize * @param blockSize block size
* @param progress * @param progress the progress reporter
* @throws IOException * @throws IOException
* @see #setPermission(Path, FsPermission) * @see #setPermission(Path, FsPermission)
*/ */
@ -1136,12 +1136,12 @@ public abstract class FileSystem extends Configured implements Closeable {
* reporting. Same as create(), except fails if parent directory doesn't * reporting. Same as create(), except fails if parent directory doesn't
* already exist. * already exist.
* @param f the file name to open * @param f the file name to open
* @param permission * @param permission file permission
* @param flags {@link CreateFlag}s to use for this stream. * @param flags {@link CreateFlag}s to use for this stream.
* @param bufferSize the size of the buffer to be used. * @param bufferSize the size of the buffer to be used.
* @param replication required block replication for the file. * @param replication required block replication for the file.
* @param blockSize * @param blockSize block size
* @param progress * @param progress the progress reporter
* @throws IOException * @throws IOException
* @see #setPermission(Path, FsPermission) * @see #setPermission(Path, FsPermission)
*/ */
@ -1881,7 +1881,7 @@ public abstract class FileSystem extends Configured implements Closeable {
* Set the current working directory for the given file system. All relative * Set the current working directory for the given file system. All relative
* paths will be resolved relative to it. * paths will be resolved relative to it.
* *
* @param new_dir * @param new_dir Path of new working directory
*/ */
public abstract void setWorkingDirectory(Path new_dir); public abstract void setWorkingDirectory(Path new_dir);
@ -2324,7 +2324,7 @@ public abstract class FileSystem extends Configured implements Closeable {
/** /**
* Set the verify checksum flag. This is only applicable if the * Set the verify checksum flag. This is only applicable if the
* corresponding FileSystem supports checksum. By default doesn't do anything. * corresponding FileSystem supports checksum. By default doesn't do anything.
* @param verifyChecksum * @param verifyChecksum Verify checksum flag
*/ */
public void setVerifyChecksum(boolean verifyChecksum) { public void setVerifyChecksum(boolean verifyChecksum) {
//doesn't do anything //doesn't do anything
@ -2333,7 +2333,7 @@ public abstract class FileSystem extends Configured implements Closeable {
/** /**
* Set the write checksum flag. This is only applicable if the * Set the write checksum flag. This is only applicable if the
* corresponding FileSystem supports checksum. By default doesn't do anything. * corresponding FileSystem supports checksum. By default doesn't do anything.
* @param writeChecksum * @param writeChecksum Write checsum flag
*/ */
public void setWriteChecksum(boolean writeChecksum) { public void setWriteChecksum(boolean writeChecksum) {
//doesn't do anything //doesn't do anything
@ -2369,8 +2369,8 @@ public abstract class FileSystem extends Configured implements Closeable {
/** /**
* Set permission of a path. * Set permission of a path.
* @param p * @param p The path
* @param permission * @param permission permission
*/ */
public void setPermission(Path p, FsPermission permission public void setPermission(Path p, FsPermission permission
) throws IOException { ) throws IOException {
@ -2590,7 +2590,7 @@ public abstract class FileSystem extends Configured implements Closeable {
* Refer to the HDFS extended attributes user documentation for details. * Refer to the HDFS extended attributes user documentation for details.
* *
* @param path Path to get extended attributes * @param path Path to get extended attributes
* @return Map<String, byte[]> describing the XAttrs of the file or directory * @return Map describing the XAttrs of the file or directory
* @throws IOException * @throws IOException
*/ */
public Map<String, byte[]> getXAttrs(Path path) throws IOException { public Map<String, byte[]> getXAttrs(Path path) throws IOException {
@ -2607,7 +2607,7 @@ public abstract class FileSystem extends Configured implements Closeable {
* *
* @param path Path to get extended attributes * @param path Path to get extended attributes
* @param names XAttr names. * @param names XAttr names.
* @return Map<String, byte[]> describing the XAttrs of the file or directory * @return Map describing the XAttrs of the file or directory
* @throws IOException * @throws IOException
*/ */
public Map<String, byte[]> getXAttrs(Path path, List<String> names) public Map<String, byte[]> getXAttrs(Path path, List<String> names)
@ -3520,7 +3520,7 @@ public abstract class FileSystem extends Configured implements Closeable {
* In order to reset, we add up all the thread-local statistics data, and * In order to reset, we add up all the thread-local statistics data, and
* set rootData to the negative of that. * set rootData to the negative of that.
* *
* This may seem like a counterintuitive way to reset the statsitics. Why * This may seem like a counterintuitive way to reset the statistics. Why
* can't we just zero out all the thread-local data? Well, thread-local * can't we just zero out all the thread-local data? Well, thread-local
* data can only be modified by the thread that owns it. If we tried to * data can only be modified by the thread that owns it. If we tried to
* modify the thread-local data from this thread, our modification might get * modify the thread-local data from this thread, our modification might get