HADOOP-11850: Typos in hadoop-common java docs. Contributed by Surendra Singh Lilhore.
This commit is contained in:
Jakob Homan
parent
a3b1d8c902
commit
e54a3e1f4f
@ -14,7 +14,7 @@
|
||||
package org.apache.hadoop.security.authentication.client;
|
||||
|
||||
/**
|
||||
* Exception thrown when an authentication error occurrs.
|
||||
* Exception thrown when an authentication error occurs.
|
||||
*/
|
||||
public class AuthenticationException extends Exception {
|
||||
|
||||
|
||||
@ -57,7 +57,7 @@ public void setConnectionConfigurator(ConnectionConfigurator configurator) {
|
||||
* If the response is successful it will update the authentication token.
|
||||
*
|
||||
* @param url the URl to authenticate against.
|
||||
* @param token the authencation token being used for the user.
|
||||
* @param token the authentication token being used for the user.
|
||||
*
|
||||
* @throws IOException if an IO error occurred.
|
||||
* @throws AuthenticationException if an authentication error occurred.
|
||||
|
||||
@ -198,6 +198,9 @@ Trunk (Unreleased)
|
||||
HADOOP-11781. fix race conditions and add URL support to
|
||||
smart-apply-patch.sh (Raymie Stata via aw)
|
||||
|
||||
HADOOP-11850. Typos in hadoop-common java docs. (Surendra Singh Lilhore
|
||||
via jghoman)
|
||||
|
||||
BUG FIXES
|
||||
|
||||
HADOOP-11473. test-patch says "-1 overall" even when all checks are +1
|
||||
|
||||
@ -27,7 +27,7 @@
|
||||
|
||||
|
||||
/**
|
||||
* A class optimizes reading from FSInputStream by bufferring
|
||||
* A class that optimizes reading from FSInputStream by buffering
|
||||
*/
|
||||
|
||||
@InterfaceAudience.Private
|
||||
|
||||
@ -662,7 +662,7 @@ public void completeLocalOutput(Path fsOutputFile, Path tmpLocalFile)
|
||||
* @param inPos the position of the beginning of the bad data in the file
|
||||
* @param sums the stream open on the checksum file
|
||||
* @param sumsPos the position of the beginning of the bad data in the checksum file
|
||||
* @return if retry is neccessary
|
||||
* @return if retry is necessary
|
||||
*/
|
||||
public boolean reportChecksumFailure(Path f, FSDataInputStream in,
|
||||
long inPos, FSDataInputStream sums, long sumsPos) {
|
||||
|
||||
@ -507,7 +507,7 @@ public boolean delete(Path f, boolean recursive)
|
||||
* @param sums the stream open on the checksum file
|
||||
* @param sumsPos the position of the beginning of the bad data in the
|
||||
* checksum file
|
||||
* @return if retry is neccessary
|
||||
* @return if retry is necessary
|
||||
*/
|
||||
public boolean reportChecksumFailure(Path f, FSDataInputStream in,
|
||||
long inPos, FSDataInputStream sums, long sumsPos) {
|
||||
|
||||
@ -175,7 +175,7 @@ private ContentSummary(
|
||||
/** Return the directory quota */
|
||||
public long getQuota() {return quota;}
|
||||
|
||||
/** Retuns storage space consumed */
|
||||
/** Returns storage space consumed */
|
||||
public long getSpaceConsumed() {return spaceConsumed;}
|
||||
|
||||
/** Returns storage space quota */
|
||||
|
||||
@ -112,7 +112,7 @@ protected FSInputChecker( Path file, int numOfRetries,
|
||||
* for sequential reading.
|
||||
*
|
||||
* @param pos chunkPos
|
||||
* @param buf desitination buffer
|
||||
* @param buf destination buffer
|
||||
* @param offset offset in buf at which to store data
|
||||
* @param len maximum number of bytes to read
|
||||
* @param checksum the data buffer into which to write checksums
|
||||
@ -123,7 +123,7 @@ abstract protected int readChunk(long pos, byte[] buf, int offset, int len,
|
||||
|
||||
/** Return position of beginning of chunk containing pos.
|
||||
*
|
||||
* @param pos a postion in the file
|
||||
* @param pos a position in the file
|
||||
* @return the starting position of the chunk which contains the byte
|
||||
*/
|
||||
abstract protected long getChunkPosition(long pos);
|
||||
@ -388,7 +388,7 @@ public synchronized long skip(long n) throws IOException {
|
||||
* This produces no exception and an attempt to read from
|
||||
* the stream will result in -1 indicating the end of the file.
|
||||
*
|
||||
* @param pos the postion to seek to.
|
||||
* @param pos the position to seek to.
|
||||
* @exception IOException if an I/O error occurs.
|
||||
* ChecksumException if the chunk to seek to is corrupted
|
||||
*/
|
||||
@ -423,7 +423,7 @@ public synchronized void seek(long pos) throws IOException {
|
||||
* <code>stm</code>
|
||||
*
|
||||
* @param stm an input stream
|
||||
* @param buf destiniation buffer
|
||||
* @param buf destination buffer
|
||||
* @param offset offset at which to store data
|
||||
* @param len number of bytes to read
|
||||
* @return actual number of bytes read
|
||||
|
||||
@ -92,7 +92,7 @@ public synchronized void write(int b) throws IOException {
|
||||
* in a checksum chunk are in the buffer. If the buffer is empty and
|
||||
* requested length is at least as large as the size of next checksum chunk
|
||||
* size, this method will checksum and write the chunk directly
|
||||
* to the underlying output stream. Thus it avoids uneccessary data copy.
|
||||
* to the underlying output stream. Thus it avoids unnecessary data copy.
|
||||
*
|
||||
* @param b the data.
|
||||
* @param off the start offset in the data.
|
||||
|
||||
@ -342,7 +342,7 @@ public AbstractFileSystem run() throws UnsupportedFileSystemException {
|
||||
*
|
||||
* @param defFS
|
||||
* @param aConf
|
||||
* @return new FileContext with specifed FS as default.
|
||||
* @return new FileContext with specified FS as default.
|
||||
*/
|
||||
public static FileContext getFileContext(final AbstractFileSystem defFS,
|
||||
final Configuration aConf) {
|
||||
@ -612,7 +612,7 @@ public Path makeQualified(final Path path) {
|
||||
* @param opts file creation options; see {@link Options.CreateOpts}.
|
||||
* <ul>
|
||||
* <li>Progress - to report progress on the operation - default null
|
||||
* <li>Permission - umask is applied against permisssion: default is
|
||||
* <li>Permission - umask is applied against permission: default is
|
||||
* FsPermissions:getDefault()
|
||||
*
|
||||
* <li>CreateParent - create missing parent path; default is to not
|
||||
|
||||
@ -193,7 +193,7 @@ public long getAccessTime() {
|
||||
|
||||
/**
|
||||
* Get FsPermission associated with the file.
|
||||
* @return permssion. If a filesystem does not have a notion of permissions
|
||||
* @return permission. If a filesystem does not have a notion of permissions
|
||||
* or if permissions could not be determined, then default
|
||||
* permissions equivalent of "rwxrwxrwx" is returned.
|
||||
*/
|
||||
|
||||
@ -119,7 +119,7 @@ public abstract class FileSystem extends Configured implements Closeable {
|
||||
protected Statistics statistics;
|
||||
|
||||
/**
|
||||
* A cache of files that should be deleted when filsystem is closed
|
||||
* A cache of files that should be deleted when filesystem is closed
|
||||
* or the JVM is exited.
|
||||
*/
|
||||
private Set<Path> deleteOnExit = new TreeSet<Path>();
|
||||
|
||||
@ -952,7 +952,7 @@ public synchronized int read() throws IOException {
|
||||
return (ret <= 0) ? -1: (oneBytebuff[0] & 0xff);
|
||||
}
|
||||
|
||||
// NB: currently this method actually never executed becusae
|
||||
// NB: currently this method actually never executed because
|
||||
// java.io.DataInputStream.read(byte[]) directly delegates to
|
||||
// method java.io.InputStream.read(byte[], int, int).
|
||||
// However, potentially it can be invoked, so leave it intact for now.
|
||||
|
||||
@ -82,7 +82,7 @@ protected void processOptions(LinkedList<String> args) throws IOException {
|
||||
}
|
||||
}
|
||||
|
||||
/** move/rename paths on the same fileystem */
|
||||
/** move/rename paths on the same filesystem */
|
||||
public static class Rename extends CommandWithDestination {
|
||||
public static final String NAME = "mv";
|
||||
public static final String USAGE = "<src> ... <dst>";
|
||||
|
||||
@ -106,7 +106,7 @@ private PathData(FileSystem fs, String pathString) throws IOException {
|
||||
|
||||
/**
|
||||
* Validates the given Windows path.
|
||||
* @param pathString a String of the path suppliued by the user.
|
||||
* @param pathString a String of the path supplied by the user.
|
||||
* @return true if the URI scheme was not present in the pathString but
|
||||
* inferred; false, otherwise.
|
||||
* @throws IOException if anything goes wrong
|
||||
|
||||
@ -104,7 +104,7 @@ public static String getHomeDirValue(final Configuration conf) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the value of the home dir conf value for specfied mount table
|
||||
* Get the value of the home dir conf value for specified mount table
|
||||
* @param conf - from this conf
|
||||
* @param mountTableName - the mount table
|
||||
* @return home dir value, null if variable is not in conf
|
||||
|
||||
@ -146,12 +146,12 @@ public int find(String what) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds any occurence of <code>what</code> in the backing
|
||||
* Finds any occurrence of <code>what</code> in the backing
|
||||
* buffer, starting as position <code>start</code>. The starting
|
||||
* position is measured in bytes and the return value is in
|
||||
* terms of byte position in the buffer. The backing buffer is
|
||||
* not converted to a string for this operation.
|
||||
* @return byte position of the first occurence of the search
|
||||
* @return byte position of the first occurrence of the search
|
||||
* string in the UTF-8 buffer or -1 if not found
|
||||
*/
|
||||
public int find(String what, int start) {
|
||||
|
||||
@ -30,7 +30,7 @@
|
||||
|
||||
/** A Comparator for {@link WritableComparable}s.
|
||||
*
|
||||
* <p>This base implemenation uses the natural ordering. To define alternate
|
||||
* <p>This base implementation uses the natural ordering. To define alternate
|
||||
* orderings, override {@link #compare(WritableComparable,WritableComparable)}.
|
||||
*
|
||||
* <p>One may optimize compare-intensive operations by overriding
|
||||
|
||||
@ -223,7 +223,7 @@ public static <T extends Writable> T clone(T orig, Configuration conf) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Make a copy of the writable object using serialiation to a buffer
|
||||
* Make a copy of the writable object using serialization to a buffer
|
||||
* @param dst the object to copy from
|
||||
* @param src the object to copy into, which is destroyed
|
||||
* @throws IOException
|
||||
|
||||
@ -1219,7 +1219,7 @@ private static final class Data extends Object {
|
||||
* Initializes the {@link #tt} array.
|
||||
*
|
||||
* This method is called when the required length of the array is known.
|
||||
* I don't initialize it at construction time to avoid unneccessary
|
||||
* I don't initialize it at construction time to avoid unnecessary
|
||||
* memory allocation when compressing small files.
|
||||
*/
|
||||
final int[] initTT(int length) {
|
||||
|
||||
@ -42,7 +42,7 @@ class BoundedRangeFileInputStream extends InputStream {
|
||||
* @param in
|
||||
* The FSDataInputStream we connect to.
|
||||
* @param offset
|
||||
* Begining offset of the region.
|
||||
* Beginning offset of the region.
|
||||
* @param length
|
||||
* Length of the region.
|
||||
*
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
package org.apache.hadoop.ipc;
|
||||
|
||||
public interface FairCallQueueMXBean {
|
||||
// Get the size of each subqueue, the index corrosponding to the priority
|
||||
// Get the size of each subqueue, the index corresponding to the priority
|
||||
// level.
|
||||
int[] getQueueSizes();
|
||||
long[] getOverflowedCalls();
|
||||
|
||||
Loading…
Reference in New Issue
Block a user