HADOOP-11786. Fix Javadoc typos in org.apache.hadoop.fs.FileSystem. Contributed by Andras Bokor.
This commit is contained in:
Anu Engineer
parent
986162f977
commit
ac8c3ae784
|
|
@ -934,13 +934,13 @@ public abstract class FileSystem extends Configured implements Closeable {
|
|||
* Create an FSDataOutputStream at the indicated Path with write-progress
|
||||
* reporting.
|
||||
* @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,
|
||||
* the file will be overwritten, and if false an error will be thrown.
|
||||
* @param bufferSize the size of the buffer to be used.
|
||||
* @param replication required block replication for the file.
|
||||
* @param blockSize
|
||||
* @param progress
|
||||
* @param blockSize block size
|
||||
* @param progress the progress reporter
|
||||
* @throws IOException
|
||||
* @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
|
||||
* reporting.
|
||||
* @param f the file name to open
|
||||
* @param permission
|
||||
* @param permission file permission
|
||||
* @param flags {@link CreateFlag}s to use for this stream.
|
||||
* @param bufferSize the size of the buffer to be used.
|
||||
* @param replication required block replication for the file.
|
||||
* @param blockSize
|
||||
* @param progress
|
||||
* @param blockSize block size
|
||||
* @param progress the progress reporter
|
||||
* @throws IOException
|
||||
* @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
|
||||
* checksum option
|
||||
* @param f the file name to open
|
||||
* @param permission
|
||||
* @param permission file permission
|
||||
* @param flags {@link CreateFlag}s to use for this stream.
|
||||
* @param bufferSize the size of the buffer to be used.
|
||||
* @param replication required block replication for the file.
|
||||
* @param blockSize
|
||||
* @param progress
|
||||
* @param blockSize block size
|
||||
* @param progress the progress reporter
|
||||
* @param checksumOpt checksum parameter. If null, the values
|
||||
* found in conf will be used.
|
||||
* @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.
|
||||
* @param bufferSize the size of the buffer to be used.
|
||||
* @param replication required block replication for the file.
|
||||
* @param blockSize
|
||||
* @param progress
|
||||
* @param blockSize block size
|
||||
* @param progress the progress reporter
|
||||
* @throws IOException
|
||||
* @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
|
||||
* already exist.
|
||||
* @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,
|
||||
* the file will be overwritten, and if false an error will be thrown.
|
||||
* @param bufferSize the size of the buffer to be used.
|
||||
* @param replication required block replication for the file.
|
||||
* @param blockSize
|
||||
* @param progress
|
||||
* @param blockSize block size
|
||||
* @param progress the progress reporter
|
||||
* @throws IOException
|
||||
* @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
|
||||
* already exist.
|
||||
* @param f the file name to open
|
||||
* @param permission
|
||||
* @param permission file permission
|
||||
* @param flags {@link CreateFlag}s to use for this stream.
|
||||
* @param bufferSize the size of the buffer to be used.
|
||||
* @param replication required block replication for the file.
|
||||
* @param blockSize
|
||||
* @param progress
|
||||
* @param blockSize block size
|
||||
* @param progress the progress reporter
|
||||
* @throws IOException
|
||||
* @see #setPermission(Path, FsPermission)
|
||||
*/
|
||||
|
|
@ -1882,7 +1882,7 @@ public abstract class FileSystem extends Configured implements Closeable {
|
|||
* Set the current working directory for the given file system. All relative
|
||||
* 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);
|
||||
|
||||
|
|
@ -2325,7 +2325,7 @@ public abstract class FileSystem extends Configured implements Closeable {
|
|||
/**
|
||||
* Set the verify checksum flag. This is only applicable if the
|
||||
* corresponding FileSystem supports checksum. By default doesn't do anything.
|
||||
* @param verifyChecksum
|
||||
* @param verifyChecksum Verify checksum flag
|
||||
*/
|
||||
public void setVerifyChecksum(boolean verifyChecksum) {
|
||||
//doesn't do anything
|
||||
|
|
@ -2334,7 +2334,7 @@ public abstract class FileSystem extends Configured implements Closeable {
|
|||
/**
|
||||
* Set the write checksum flag. This is only applicable if the
|
||||
* corresponding FileSystem supports checksum. By default doesn't do anything.
|
||||
* @param writeChecksum
|
||||
* @param writeChecksum Write checsum flag
|
||||
*/
|
||||
public void setWriteChecksum(boolean writeChecksum) {
|
||||
//doesn't do anything
|
||||
|
|
@ -2370,8 +2370,8 @@ public abstract class FileSystem extends Configured implements Closeable {
|
|||
|
||||
/**
|
||||
* Set permission of a path.
|
||||
* @param p
|
||||
* @param permission
|
||||
* @param p The path
|
||||
* @param permission permission
|
||||
*/
|
||||
public void setPermission(Path p, FsPermission permission
|
||||
) throws IOException {
|
||||
|
|
@ -2591,7 +2591,7 @@ public abstract class FileSystem extends Configured implements Closeable {
|
|||
* Refer to the HDFS extended attributes user documentation for details.
|
||||
*
|
||||
* @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
|
||||
*/
|
||||
public Map<String, byte[]> getXAttrs(Path path) throws IOException {
|
||||
|
|
@ -2608,7 +2608,7 @@ public abstract class FileSystem extends Configured implements Closeable {
|
|||
*
|
||||
* @param path Path to get extended attributes
|
||||
* @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
|
||||
*/
|
||||
public Map<String, byte[]> getXAttrs(Path path, List<String> names)
|
||||
|
|
@ -3521,7 +3521,7 @@ public abstract class FileSystem extends Configured implements Closeable {
|
|||
* In order to reset, we add up all the thread-local statistics data, and
|
||||
* 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
|
||||
* 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
|
||||
|
|
|
|||
Loading…
Reference in New Issue