name property as
* a host:port.
+ * @param name property name.
+ * @param addr inetSocketAddress addr.
*/
public void setSocketAddr(String name, InetSocketAddress addr) {
set(name, NetUtils.getHostPortString(addr));
@@ -2702,6 +2706,7 @@ public Class getClass(String name, Class defaultValue) {
* @param name the conf key name.
* @param defaultValue default value.
* @param xface the interface implemented by the named class.
+ * @param Interface class type.
* @return property value as a Class,
* or defaultValue.
*/
@@ -2731,6 +2736,7 @@ else if (theClass != null)
* @param name the property name.
* @param xface the interface implemented by the classes named by
* name.
+ * @param Interface class type.
* @return a List of objects implementing xface.
*/
@SuppressWarnings("unchecked")
@@ -2763,15 +2769,16 @@ public void setClass(String name, Class theClass, Class xface) {
set(name, theClass.getName());
}
- /**
+ /**
* Get a local file under a directory named by dirsProp with
* the given path. If dirsProp contains multiple directories,
* then one is chosen based on path's hash code. If the selected
* directory does not exist, an attempt is made to create it.
- *
+ *
* @param dirsProp directory in which to locate the file.
* @param path file-path.
* @return local file under the directory with the given path.
+ * @throws IOException raised on errors performing I/O.
*/
public Path getLocalPath(String dirsProp, String path)
throws IOException {
@@ -2795,15 +2802,16 @@ public Path getLocalPath(String dirsProp, String path)
throw new IOException("No valid local directories in property: "+dirsProp);
}
- /**
+ /**
* Get a local file name under a directory named in dirsProp with
* the given path. If dirsProp contains multiple directories,
* then one is chosen based on path's hash code. If the selected
* directory does not exist, an attempt is made to create it.
- *
+ *
* @param dirsProp directory in which to locate the file.
* @param path file-path.
* @return local file under the directory with the given path.
+ * @throws IOException raised on errors performing I/O.
*/
public File getFile(String dirsProp, String path)
throws IOException {
@@ -3415,7 +3423,7 @@ void parseNext() throws IOException, XMLStreamException {
/**
* Add tags defined in HADOOP_TAGS_SYSTEM, HADOOP_TAGS_CUSTOM.
- * @param prop
+ * @param prop properties.
*/
public void addTags(Properties prop) {
// Get all system tags
@@ -3516,7 +3524,7 @@ private void loadProperty(Properties properties, String name, String attr,
/**
* Print a warning if a property with a given name already exists with a
- * different value
+ * different value.
*/
private void checkForOverride(Properties properties, String name, String attr, String value) {
String propertyValue = properties.getProperty(attr);
@@ -3526,11 +3534,12 @@ private void checkForOverride(Properties properties, String name, String attr, S
}
}
- /**
+ /**
* Write out the non-default properties in this configuration to the given
* {@link OutputStream} using UTF-8 encoding.
- *
+ *
* @param out the output stream to write to.
+ * @throws IOException raised on errors performing I/O.
*/
public void writeXml(OutputStream out) throws IOException {
writeXml(new OutputStreamWriter(out, "UTF-8"));
@@ -3560,7 +3569,9 @@ public void writeXml(Writer out) throws IOException {
* the configuration, this method throws an {@link IllegalArgumentException}.
*
*
+ * @param propertyName xml property name.
* @param out the writer to write to.
+ * @throws IOException raised on errors performing I/O.
*/
public void writeXml(@Nullable String propertyName, Writer out)
throws IOException, IllegalArgumentException {
@@ -3714,7 +3725,7 @@ private synchronized void appendXMLProperty(Document doc, Element conf,
* @param config the configuration
* @param propertyName property name
* @param out the Writer to write to
- * @throws IOException
+ * @throws IOException raised on errors performing I/O.
* @throws IllegalArgumentException when property name is not
* empty and the property is not found in configuration
**/
@@ -3761,7 +3772,7 @@ public static void dumpConfiguration(Configuration config,
*
* @param config the configuration
* @param out the Writer to write to
- * @throws IOException
+ * @throws IOException raised on errors performing I/O.
*/
public static void dumpConfiguration(Configuration config,
Writer out) throws IOException {
@@ -3790,7 +3801,7 @@ public static void dumpConfiguration(Configuration config,
* @param jsonGen json writer
* @param config configuration
* @param name property name
- * @throws IOException
+ * @throws IOException raised on errors performing I/O.
*/
private static void appendJSONProperty(JsonGenerator jsonGen,
Configuration config, String name, ConfigRedactor redactor)
@@ -3872,7 +3883,10 @@ synchronized boolean getQuietMode() {
return this.quietmode;
}
- /** For debugging. List non-default properties to the terminal and exit. */
+ /** For debugging. List non-default properties to the terminal and exit.
+ * @param args the argument to be parsed.
+ * @throws Exception exception.
+ */
public static void main(String[] args) throws Exception {
new Configuration().writeXml(System.out);
}
@@ -3906,8 +3920,8 @@ public void write(DataOutput out) throws IOException {
}
/**
- * get keys matching the the regex
- * @param regex
+ * get keys matching the the regex.
+ * @param regex the regex to match against.
* @return {@literal Map- * * The result is stored in the output buffer. Upon return, the output buffer's * position will have advanced by n, where n is the value returned by this * method; the output buffer's limit will not have changed. - *
- * + *
* Ifoutput.remaining() bytes are insufficient to hold the result,
* a ShortBufferException is thrown.
* - * * Upon finishing, this method resets this cipher object to the state it was * in when previously initialized. That is, the object is available to encrypt * or decrypt more data. - *
- * - * If any exception is thrown, this cipher object need to be reset before it + *
+ * If any exception is thrown, this cipher object need to be reset before it * can be used again. - * + * * @param output the output ByteBuffer * @return int number of bytes stored inoutput
- * @throws ShortBufferException
- * @throws IllegalBlockSizeException
- * @throws BadPaddingException
+ * @throws ShortBufferException if there is insufficient space in the output buffer.
+ * @throws IllegalBlockSizeException This exception is thrown when the length
+ * of data provided to a block cipher is incorrect.
+ * @throws BadPaddingException This exception is thrown when a particular
+ * padding mechanism is expected for the input
+ * data but the data is not padded properly.
*/
public int doFinal(ByteBuffer output) throws ShortBufferException,
IllegalBlockSizeException, BadPaddingException {
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/KeyProvider.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/KeyProvider.java
index a8c283ab649cc..13aa383c1901b 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/KeyProvider.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/KeyProvider.java
@@ -245,7 +245,7 @@ protected int addVersion() {
/**
* Serialize the metadata to a set of bytes.
* @return the serialized bytes
- * @throws IOException
+ * @throws IOException raised on errors performing I/O.
*/
protected byte[] serialize() throws IOException {
ByteArrayOutputStream buffer = new ByteArrayOutputStream();
@@ -284,7 +284,7 @@ protected byte[] serialize() throws IOException {
/**
* Deserialize a new metadata object from a set of bytes.
* @param bytes the serialized metadata
- * @throws IOException
+ * @throws IOException raised on errors performing I/O.
*/
protected Metadata(byte[] bytes) throws IOException {
String cipher = null;
@@ -449,7 +449,7 @@ public boolean isTransient() {
* when decrypting data.
* @param versionName the name of a specific version of the key
* @return the key material
- * @throws IOException
+ * @throws IOException raised on errors performing I/O.
*/
public abstract KeyVersion getKeyVersion(String versionName
) throws IOException;
@@ -457,14 +457,15 @@ public abstract KeyVersion getKeyVersion(String versionName
/**
* Get the key names for all keys.
* @return the list of key names
- * @throws IOException
+ * @throws IOException raised on errors performing I/O.
*/
public abstract Listuri has syntax error
*/
public AbstractFileSystem(final URI uri, final String supportedScheme,
@@ -282,11 +282,12 @@ public AbstractFileSystem(final URI uri, final String supportedScheme,
myUri = getUri(uri, supportedScheme, authorityNeeded, defaultPort);
statistics = getStatistics(uri);
}
-
+
/**
- * Check that the Uri's scheme matches
- * @param uri
- * @param supportedScheme
+ * Check that the Uri's scheme matches.
+ *
+ * @param uri name URI of the FS.
+ * @param supportedScheme supported scheme.
*/
public void checkScheme(URI uri, String supportedScheme) {
String scheme = uri.getScheme();
@@ -363,7 +364,7 @@ public URI getUri() {
* If the path is fully qualified URI, then its scheme and authority
* matches that of this file system. Otherwise the path must be
* slash-relative name.
- *
+ * @param path the path.
* @throws InvalidPathException if the path is invalid
*/
public void checkPath(Path path) {
@@ -432,7 +433,7 @@ public String getUriPath(final Path p) {
/**
* Make the path fully qualified to this file system
- * @param path
+ * @param path the path.
* @return the qualified path
*/
public Path makeQualified(Path path) {
@@ -497,9 +498,9 @@ public FsServerDefaults getServerDefaults(final Path f) throws IOException {
* through any internal symlinks or mount point
* @param p path to be resolved
* @return fully qualified path
- * @throws FileNotFoundException
- * @throws AccessControlException
- * @throws IOException
+ * @throws FileNotFoundException when file not find throw.
+ * @throws AccessControlException when accees control error throw.
+ * @throws IOException raised on errors performing I/O.
* @throws UnresolvedLinkException if symbolic link on path cannot be
* resolved internally
*/
@@ -514,6 +515,18 @@ public Path resolvePath(final Path p) throws FileNotFoundException,
* {@link FileContext#create(Path, EnumSet, Options.CreateOpts...)} except
* that the Path f must be fully qualified and the permission is absolute
* (i.e. umask has been applied).
+ *
+ * @param f the path.
+ * @param createFlag create_flag.
+ * @param opts create ops.
+ * @throws AccessControlException access controll exception.
+ * @throws FileAlreadyExistsException file already exception.
+ * @throws FileNotFoundException file not found exception.
+ * @throws ParentNotDirectoryException parent not dir exception.
+ * @throws UnsupportedFileSystemException unsupported file system exception.
+ * @throws UnresolvedLinkException unresolved link exception.
+ * @throws IOException raised on errors performing I/O.
+ * @return output stream.
*/
public final FSDataOutputStream create(final Path f,
final EnumSet* A higher number here does not necessarily improve performance, especially * for object stores, where multiple threads may be attempting to create an FS * instance for the same URI. - *
+ * * Default value: {@value}. */ public static final String FS_CREATION_PARALLEL_COUNT = @@ -179,8 +179,9 @@ public class CommonConfigurationKeysPublic { /** * Default value for {@link #FS_CREATION_PARALLEL_COUNT}. - * + ** Default value: {@value}. + *
*/ public static final int FS_CREATION_PARALLEL_COUNT_DEFAULT = 64; diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/CompositeCrcFileChecksum.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/CompositeCrcFileChecksum.java index e1ed5cbcfcaa6..bdbc8f3a33f4b 100644 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/CompositeCrcFileChecksum.java +++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/CompositeCrcFileChecksum.java @@ -37,7 +37,13 @@ public class CompositeCrcFileChecksum extends FileChecksum { private DataChecksum.Type crcType; private int bytesPerCrc; - /** Create a CompositeCrcFileChecksum. */ + /** + * Create a CompositeCrcFileChecksum. + * + * @param crc crc. + * @param crcType crcType. + * @param bytesPerCrc bytesPerCrc. + */ public CompositeCrcFileChecksum( int crc, DataChecksum.Type crcType, int bytesPerCrc) { this.crc = crc; diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/ContentSummary.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/ContentSummary.java index 20e205a8b32cf..4759ffea7d038 100644 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/ContentSummary.java +++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/ContentSummary.java @@ -149,17 +149,31 @@ public ContentSummary build() { @Deprecated public ContentSummary() {} - /** Constructor, deprecated by ContentSummary.Builder + /** + * Constructor, deprecated by ContentSummary.Builder * This constructor implicitly set spaceConsumed the same as length. * spaceConsumed and length must be set explicitly with - * ContentSummary.Builder + * ContentSummary.Builder. + * + * @param length length. + * @param fileCount file count. + * @param directoryCount directory count. * */ @Deprecated public ContentSummary(long length, long fileCount, long directoryCount) { this(length, fileCount, directoryCount, -1L, length, -1L); } - /** Constructor, deprecated by ContentSummary.Builder */ + /** + * Constructor, deprecated by ContentSummary.Builder. + * + * @param length length. + * @param fileCount file count. + * @param directoryCount directory count. + * @param quota quota. + * @param spaceConsumed space consumed. + * @param spaceQuota space quota. + * */ @Deprecated public ContentSummary( long length, long fileCount, long directoryCount, long quota, @@ -172,7 +186,11 @@ public ContentSummary( setSpaceQuota(spaceQuota); } - /** Constructor for ContentSummary.Builder*/ + /** + * Constructor for ContentSummary.Builder. + * + * @param builder builder. + */ private ContentSummary(Builder builder) { super(builder); this.length = builder.length; diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/CreateFlag.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/CreateFlag.java index 71993713ad2eb..ca008e536931d 100644 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/CreateFlag.java +++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/CreateFlag.java @@ -189,6 +189,8 @@ public static void validate(Object path, boolean pathExists, /** * Validate the CreateFlag for the append operation. The flag must contain * APPEND, and cannot contain OVERWRITE. + * + * @param flag enum set flag. */ public static void validateForAppend(EnumSetf does not exist
* @throws AccessControlException if access denied
* @throws IOException If an IO Error occurred
- *
+ * @throws UnresolvedLinkException If unresolved link occurred.
+ *
* Exceptions applicable to file systems accessed over RPC:
* @throws RpcClientException If an exception occurred in the RPC client
* @throws RpcServerException If an exception occurred in the RPC server
* @throws UnexpectedServerException If server implementation throws
* undeclared exception to RPC server
- *
+ *
* RuntimeExceptions:
* @throws InvalidPathException If path f is not valid
*/
@@ -626,7 +629,7 @@ public Path resolvePath(final Path f) throws FileNotFoundException,
* A Fully-qualified path has scheme and authority specified and an absolute
* path.
* Use the default file system and working dir in this FileContext to qualify.
- * @param path
+ * @param path the path.
* @return qualified path
*/
public Path makeQualified(final Path path) {
@@ -765,6 +768,7 @@ public FSDataOutputStream build() throws IOException {
*
* Client should expect {@link FSDataOutputStreamBuilder#build()} throw the
* same exceptions as create(Path, EnumSet, CreateOpts...).
+ * @throws IOException If an I/O error occurred.
*/
public FSDataOutputStreamBuilderf is invalid
+ *
+ * @return if delete success true, not false.
*/
public boolean delete(final Path f, final boolean recursive)
throws AccessControlException, FileNotFoundException,
@@ -868,6 +874,7 @@ public Boolean next(final AbstractFileSystem fs, final Path p)
* @throws RpcServerException If an exception occurred in the RPC server
* @throws UnexpectedServerException If server implementation throws
* undeclared exception to RPC server
+ * @return input stream.
*/
public FSDataInputStream open(final Path f) throws AccessControlException,
FileNotFoundException, UnsupportedFileSystemException, IOException {
@@ -898,6 +905,7 @@ public FSDataInputStream next(final AbstractFileSystem fs, final Path p)
* @throws RpcServerException If an exception occurred in the RPC server
* @throws UnexpectedServerException If server implementation throws
* undeclared exception to RPC server
+ * @return output stream.
*/
public FSDataInputStream open(final Path f, final int bufferSize)
throws AccessControlException, FileNotFoundException,
@@ -1007,6 +1015,7 @@ public Boolean next(final AbstractFileSystem fs, final Path p)
*
* @param src path to be renamed
* @param dst new path after rename
+ * @param options rename options.
*
* @throws AccessControlException If access is denied
* @throws FileAlreadyExistsException If dst already exists and
@@ -1058,7 +1067,7 @@ public Void next(final AbstractFileSystem fs, final Path p)
/**
* Set permission of a path.
- * @param f
+ * @param f the path.
* @param permission - the new absolute permission (umask is not applied)
*
* @throws AccessControlException If access is denied
@@ -1202,7 +1211,7 @@ public FileChecksum next(final AbstractFileSystem fs, final Path p)
* Set the verify checksum flag for the file system denoted by the path.
* This is only applicable if the
* corresponding FileSystem supports checksum. By default doesn't do anything.
- * @param verifyChecksum
+ * @param verifyChecksum verify check sum.
* @param f set the verifyChecksum for the Filesystem containing this path
*
* @throws AccessControlException If access is denied
@@ -1257,8 +1266,9 @@ public FileStatus next(final AbstractFileSystem fs, final Path p)
/**
* Synchronize client metadata state.
*
- * @throws IOException
- * @throws UnsupportedOperationException
+ * @throws IOException If an I/O error occurred.
+ * @throws UnsupportedOperationException If file system for f is
+ * not supported.
*/
public void msync() throws IOException, UnsupportedOperationException {
defaultFS.msync();
@@ -1619,9 +1629,12 @@ public RemoteIteratorfiles does not exist.
+ * @throws IOException If an I/O error occurred.
+ * @return file status array.
*/
public FileStatus[] listStatus(Path[] files) throws AccessControlException,
FileNotFoundException, IOException {
@@ -2060,36 +2080,29 @@ public LocatedFileStatus next() throws IOException {
* *
*
*
*
*
*
+ * *
src already exists.
+ * @throws FileNotFoundException if next file does not exist any more.
+ * @throws ParentNotDirectoryException If parent of src is not a
+ * directory.
+ * @throws UnsupportedFileSystemException If file system for
+ * src/dst is not supported.
+ * @throws IOException If an I/O error occurred.
+ * @return if success copy true, not false.
*/
public boolean copy(final Path src, final Path dst)
throws AccessControlException, FileAlreadyExistsException,
@@ -2160,8 +2185,8 @@ public boolean copy(final Path src, final Path dst)
/**
* Copy from src to dst, optionally deleting src and overwriting dst.
- * @param src
- * @param dst
+ * @param src src.
+ * @param dst dst.
* @param deleteSource - delete src if true
* @param overwrite overwrite dst if true; throw IOException if dst exists
* and overwrite is false.
@@ -2282,7 +2307,7 @@ private static void checkDependencies(Path qualSrc, Path qualDst)
* Are qualSrc and qualDst of the same file system?
* @param qualPath1 - fully qualified path
* @param qualPath2 - fully qualified path
- * @return
+ * @return is same fs true,not false.
*/
private static boolean isSameFS(Path qualPath1, Path qualPath2) {
URI srcUri = qualPath1.toUri();
@@ -2305,6 +2330,13 @@ public synchronized void run() {
/**
* Resolves all symbolic links in the specified path.
* Returns the new path object.
+ *
+ * @param f the path.
+ * @throws FileNotFoundException If f does not exist.
+ * @throws UnresolvedLinkException If unresolved link occurred.
+ * @throws AccessControlException If access is denied.
+ * @throws IOException If an I/O error occurred.
+ * @return resolve path.
*/
protected Path resolve(final Path f) throws FileNotFoundException,
UnresolvedLinkException, AccessControlException, IOException {
@@ -2322,6 +2354,7 @@ public Path next(final AbstractFileSystem fs, final Path p)
* to, but not including the final path component.
* @param f path to resolve
* @return the new path object.
+ * @throws IOException If an I/O error occurred.
*/
protected Path resolveIntermediate(final Path f) throws IOException {
return new FSLinkResolver* The local implementation is {@link LocalFileSystem} and distributed * implementation is DistributedFileSystem. There are other implementations * for object stores and (outside the Apache Hadoop codebase), * third party filesystems. - *
+ *
* Notes ** Important note for developers - *
+ * * If you are making changes here to the public API or protected methods, * you must review the following subclasses and make sure that * they are filtering/passing through new methods as appropriate. - * * * {@link FilterFileSystem}: methods are passed through. If not, * then {@code TestFilterFileSystem.MustNotImplement} must be @@ -151,21 +150,22 @@ * {@link #hasPathCapability(Path, String)} then * {@link FilterFileSystem#hasPathCapability(Path, String)} * must return false, always. - * + ** {@link ChecksumFileSystem}: checksums are created and * verified. - *
+ * * {@code TestHarFileSystem} will need its {@code MustNotImplement} * interface updated. - * * + ** There are some external places your changes will break things. * Do co-ordinate changes here. - *
+ * * * HBase: HBoss - * + ** Hive: HiveShim23 + *
* {@code shims/0.23/src/main/java/org/apache/hadoop/hive/shims/Hadoop23Shims.java} * *****************************************************************/ @@ -284,6 +284,8 @@ public FileSystem run() throws IOException { /** * Returns the configured FileSystem implementation. * @param conf the configuration to use + * @return FileSystem. + * @throws IOException If an I/O error occurred. */ public static FileSystem get(Configuration conf) throws IOException { return get(getDefaultUri(conf), conf); @@ -377,6 +379,7 @@ public String getScheme() { * implement that method. * * @see #canonicalizeUri(URI) + * @return the URI of this filesystem. */ protected URI getCanonicalUri() { return canonicalizeUri(getUri()); @@ -393,6 +396,7 @@ protected URI getCanonicalUri() { * not specified and if {@link #getDefaultPort()} returns a * default port. * + * @param uri url. * @return URI * @see NetUtils#getCanonicalUri(URI, int) */ @@ -456,11 +460,21 @@ public String getCanonicalServiceName() { : null; } - /** @deprecated call {@link #getUri()} instead.*/ + /** + * @return uri to string. + * @deprecated call {@link #getUri()} instead. + */ @Deprecated public String getName() { return getUri().toString(); } - /** @deprecated call {@link #get(URI, Configuration)} instead. */ + /** + * @deprecated call {@link #get(URI, Configuration)} instead. + * + * @param name name. + * @param conf configuration. + * @return file system. + * @throws IOException If an I/O error occurred. + */ @Deprecated public static FileSystem getNamed(String name, Configuration conf) throws IOException { @@ -515,6 +529,9 @@ public static LocalFileSystem getLocal(Configuration conf) * configuration and URI, cached and returned to the caller. ** If OVERWRITE option is not passed as an argument, rename fails * if the dst already exists. + *
** If OVERWRITE option is passed as an argument, rename overwrites * the dst if it is a file or an empty directory. Rename fails if dst is * a non-empty directory. - *
+ *
* Note that atomicity of rename is dependent on the file system * implementation. Please refer to the file system documentation for * details. This default implementation is non atomic. @@ -1558,9 +1622,11 @@ public boolean setReplication(Path src, short replication) * This method is deprecated since it is a temporary method added to * support the transition from FileSystem to FileContext for user * applications. + * * * @param src path to be renamed * @param dst new path after rename + * @param options rename options. * @throws FileNotFoundException src path does not exist, or the parent * path of dst does not exist. * @throws FileAlreadyExistsException dest path exists and is a file @@ -1655,6 +1721,9 @@ public boolean truncate(Path f, long newLength) throws IOException { /** * Delete a file/directory. + * @param f the path. + * @throws IOException IO failure. + * @return if delete success true, not false. * @deprecated Use {@link #delete(Path, boolean)} instead. */ @Deprecated @@ -1771,6 +1840,7 @@ public boolean exists(Path f) throws IOException { * @param f path to check * @throws IOException IO failure * @deprecated Use {@link #getFileStatus(Path)} instead + * @return if f is directory true, not false. */ @Deprecated public boolean isDirectory(Path f) throws IOException { @@ -1788,6 +1858,7 @@ public boolean isDirectory(Path f) throws IOException { * @param f path to check * @throws IOException IO failure * @deprecated Use {@link #getFileStatus(Path)} instead + * @return if f is file true, not false. */ @Deprecated public boolean isFile(Path f) throws IOException { @@ -1800,6 +1871,7 @@ public boolean isFile(Path f) throws IOException { /** * The number of bytes in a file. + * @param f the path. * @return the number of bytes; 0 for a directory * @deprecated Use {@link #getFileStatus(Path)} instead. * @throws FileNotFoundException if the path does not resolve @@ -1814,6 +1886,7 @@ public long getLength(Path f) throws IOException { * @param f path to use * @throws FileNotFoundException if the path does not resolve * @throws IOException IO failure + * @return content summary. */ public ContentSummary getContentSummary(Path f) throws IOException { FileStatus status = getFileStatus(f); @@ -1948,9 +2021,9 @@ public boolean hasMore() { * @param f Path to list * @param token opaque iteration token returned by previous call, or null * if this is the first call. - * @return - * @throws FileNotFoundException - * @throws IOException + * @return directory entries. + * @throws FileNotFoundException when the path does not exist. + * @throws IOException If an I/O error occurred. */ @InterfaceAudience.Private protected DirectoryEntries listStatusBatch(Path f, byte[] token) throws @@ -1981,6 +2054,8 @@ private void listStatus(ArrayList*
*
*
*
*
*
*
* returns true if the operation succeeded. When deleteSource is true, * this means "after the copy, delete(source) returned true" * If the destination is a directory, and mkdirs (dest) fails, * the operation will return false rather than raise any exception. - *
+ * * The overwrite flag is about overwriting files; it has no effect about * handing an attempt to copy a file atop a directory (expect an IOException), * or a directory over a path which contains a file (mkdir will fail, so * "false"). - * + ** The operation is recursive, and the deleteSource operation takes place * as each subdirectory is copied. Therefore, if an operation fails partway * through, the source tree may be partially deleted. + *
* @param srcFS source filesystem * @param srcStatus status of source * @param dstFS destination filesystem @@ -470,7 +501,17 @@ public static boolean copy(FileSystem srcFS, FileStatus srcStatus, } - /** Copy local files to a FileSystem. */ + /** + * Copy local files to a FileSystem. + * + * @param src src. + * @param dstFS dstFs. + * @param dst dst. + * @param deleteSource delete source. + * @param conf configuration. + * @throws IOException raised on errors performing I/O. + * @return true if the operation succeeded. + */ public static boolean copy(File src, FileSystem dstFS, Path dst, boolean deleteSource, @@ -513,7 +554,17 @@ public static boolean copy(File src, } } - /** Copy FileSystem files to local files. */ + /** + * Copy FileSystem files to local files. + * + * @param srcFS srcFs. + * @param src src. + * @param dst dst. + * @param deleteSource delete source. + * @param conf configuration. + * @throws IOException raised on errors performing I/O. + * @return true if the operation succeeded. + */ public static boolean copy(FileSystem srcFS, Path src, File dst, boolean deleteSource, Configuration conf) throws IOException { @@ -937,7 +988,7 @@ public static void unTar(InputStream inputStream, File untarDir, * * @param inFile The tar file as input. * @param untarDir The untar directory where to untar the tar file. - * @throws IOException + * @throws IOException an exception occurred. */ public static void unTar(File inFile, File untarDir) throws IOException { if (!untarDir.mkdirs()) { @@ -1148,6 +1199,7 @@ public static class HardLink extends org.apache.hadoop.fs.HardLink { * @param target the target for symlink * @param linkname the symlink * @return 0 on success + * @throws IOException raised on errors performing I/O. */ public static int symLink(String target, String linkname) throws IOException{ @@ -1209,8 +1261,8 @@ public static int symLink(String target, String linkname) throws IOException{ * @param filename the name of the file to change * @param perm the permission string * @return the exit code from the command - * @throws IOException - * @throws InterruptedException + * @throws IOException raised on errors performing I/O. + * @throws InterruptedException command interrupted. */ public static int chmod(String filename, String perm ) throws IOException, InterruptedException { @@ -1224,7 +1276,7 @@ public static int chmod(String filename, String perm * @param perm permission string * @param recursive true, if permissions should be changed recursively * @return the exit code from the command. - * @throws IOException + * @throws IOException raised on errors performing I/O. */ public static int chmod(String filename, String perm, boolean recursive) throws IOException { @@ -1250,7 +1302,7 @@ public static int chmod(String filename, String perm, boolean recursive) * @param file the file to change * @param username the new user owner name * @param groupname the new group owner name - * @throws IOException + * @throws IOException raised on errors performing I/O. */ public static void setOwner(File file, String username, String groupname) throws IOException { @@ -1267,7 +1319,7 @@ public static void setOwner(File file, String username, * Platform independent implementation for {@link File#setReadable(boolean)} * File#setReadable does not work as expected on Windows. * @param f input file - * @param readable + * @param readable readable. * @return true on success, false otherwise */ public static boolean setReadable(File f, boolean readable) { @@ -1288,7 +1340,7 @@ public static boolean setReadable(File f, boolean readable) { * Platform independent implementation for {@link File#setWritable(boolean)} * File#setWritable does not work as expected on Windows. * @param f input file - * @param writable + * @param writable writable. * @return true on success, false otherwise */ public static boolean setWritable(File f, boolean writable) { @@ -1312,7 +1364,7 @@ public static boolean setWritable(File f, boolean writable) { * behavior on Windows as on Unix platforms. Creating, deleting or renaming * a file within that folder will still succeed on Windows. * @param f input file - * @param executable + * @param executable executable. * @return true on success, false otherwise */ public static boolean setExecutable(File f, boolean executable) { @@ -1391,7 +1443,7 @@ public static boolean canExecute(File f) { * of forking if group == other. * @param f the file to change * @param permission the new permissions - * @throws IOException + * @throws IOException raised on errors performing I/O. */ public static void setPermission(File f, FsPermission permission ) throws IOException { @@ -1696,6 +1748,7 @@ public static List* The interface extends {@link IOStatisticsSource} so that there is no * need to cast an instance to see if is a source of statistics. * However, implementations MAY return null for their actual statistics. + *
*/ @InterfaceAudience.Public @InterfaceStability.Unstable diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/MultipartUploaderBuilder.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/MultipartUploaderBuilder.java index 381bfaa07f6d1..e7b0865063ee5 100644 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/MultipartUploaderBuilder.java +++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/MultipartUploaderBuilder.java @@ -25,34 +25,43 @@ /** * Builder interface for Multipart readers. - * @param* This uses FileSystem.openFile() to request sequential IO; * the file status is also passed in. * Filesystems may use to optimize their IO. + *
* @return an input stream * @throws IOException failure */ diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/find/BaseExpression.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/find/BaseExpression.java index 5069d2d34e51c..cd9bbe2bc884e 100644 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/find/BaseExpression.java +++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/find/BaseExpression.java @@ -38,12 +38,18 @@ public abstract class BaseExpression implements Expression, Configurable { private String[] usage = { "Not yet implemented" }; private String[] help = { "Not yet implemented" }; - /** Sets the usage text for this {@link Expression} */ + /** + * Sets the usage text for this {@link Expression} . + * @param usage usage array. + */ protected void setUsage(String[] usage) { this.usage = usage; } - /** Sets the help text for this {@link Expression} */ + /** + * Sets the help text for this {@link Expression} . + * @param help help. + */ protected void setHelp(String[] help) { this.help = help; } @@ -92,7 +98,10 @@ public void finish() throws IOException { /** Children of this expression. */ private LinkedList+ *
** It is annotated for correct serializations with jackson2. *
@@ -238,6 +238,8 @@ public static JsonSerializationuri is
+ * not found.
+ * @throws URISyntaxException if the URI does not have an authority
+ * it is badly formed.
+ * @throws FileAlreadyExistsException there is a file at the path specified
+ * or is discovered on one of its ancestors.
+ * @throws IOException raised on errors performing I/O.
*/
protected InodeTree(final Configuration config, final String viewName,
final URI theUri, boolean initingUriAsFallbackOnNoMounts)
@@ -774,9 +783,9 @@ boolean isLastInternalDirLink() {
/**
* Resolve the pathname p relative to root InodeDir.
* @param p - input path
- * @param resolveLastComponent
+ * @param resolveLastComponent resolveLastComponent.
* @return ResolveResult which allows further resolution of the remaining path
- * @throws IOException
+ * @throws IOException raised on errors performing I/O.
*/
public ResolveResultnth value. */
+ /**
+ * Positions the reader before its nth value.
+ *
+ * @param n n key.
+ * @throws IOException raised on errors performing I/O.
+ */
public synchronized void seek(long n) throws IOException {
key.set(n);
seek(key);
}
- /** Read and return the next value in the file. */
+ /**
+ * Read and return the next value in the file.
+ *
+ * @param value value.
+ * @throws IOException raised on errors performing I/O.
+ * @return Writable.
+ */
public synchronized Writable next(Writable value) throws IOException {
return next(key, value) ? value : null;
}
- /** Returns the key associated with the most recent call to {@link
+ /**
+ * Returns the key associated with the most recent call to {@link
* #seek(long)}, {@link #next(Writable)}, or {@link
- * #get(long,Writable)}. */
+ * #get(long,Writable)}.
+ *
+ * @return key key.
+ * @throws IOException raised on errors performing I/O.
+ */
public synchronized long key() throws IOException {
return key.get();
}
- /** Return the nth value in the file. */
+ /**
+ * Return the nth value in the file.
+ * @param n n key.
+ * @param value value.
+ * @throws IOException raised on errors performing I/O.
+ * @return writable.
+ */
public synchronized Writable get(long n, Writable value)
throws IOException {
key.set(n);
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/ArrayPrimitiveWritable.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/ArrayPrimitiveWritable.java
index 2b6f3166bc282..ce7813e7483a6 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/ArrayPrimitiveWritable.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/ArrayPrimitiveWritable.java
@@ -106,7 +106,9 @@ public ArrayPrimitiveWritable() {
/**
* Construct an instance of known type but no value yet
- * for use with type-specific wrapper classes
+ * for use with type-specific wrapper classes.
+ *
+ * @param componentType componentType.
*/
public ArrayPrimitiveWritable(Class componentType) {
checkPrimitive(componentType);
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/BinaryComparable.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/BinaryComparable.java
index a32c44c8e5058..a78ff8b6c583e 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/BinaryComparable.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/BinaryComparable.java
@@ -31,11 +31,15 @@ public abstract class BinaryComparable implements Comparablekey and
+ /**
+ * Read the next key/value pair in the map into key and
* val. Returns true if such a pair exists and false when at
- * the end of the map */
+ * the end of the map.
+ *
+ * @param key WritableComparable.
+ * @param val Writable.
+ * @return if such a pair exists true,not false.
+ * @throws IOException raised on errors performing I/O.
+ */
public synchronized boolean next(WritableComparable key, Writable val)
throws IOException {
return data.next(key, val);
}
- /** Return the value for the named key, or null if none exists. */
+ /**
+ * Return the value for the named key, or null if none exists.
+ * @param key key.
+ * @param val val.
+ * @return Writable if such a pair exists true,not false.
+ * @throws IOException raised on errors performing I/O.
+ */
public synchronized Writable get(WritableComparable key, Writable val)
throws IOException {
if (seek(key)) {
@@ -692,9 +834,10 @@ public synchronized Writable get(WritableComparable key, Writable val)
* Returns key or if it does not exist, at the first entry
* after the named key.
*
-- * @param key - key that we're trying to find
-- * @param val - data value if key is found
-- * @return - the key that was the closest match or null if eof.
+ * @param key key that we're trying to find.
+ * @param val data value if key is found.
+ * @return the key that was the closest match or null if eof.
+ * @throws IOException raised on errors performing I/O.
*/
public synchronized WritableComparable getClosest(WritableComparable key,
Writable val)
@@ -711,6 +854,7 @@ public synchronized WritableComparable getClosest(WritableComparable key,
* the first entry that falls just before the key. Otherwise,
* return the record that sorts just after.
* @return - the key that was the closest match or null if eof.
+ * @throws IOException raised on errors performing I/O.
*/
public synchronized WritableComparable getClosest(WritableComparable key,
Writable val, final boolean before)
@@ -730,7 +874,10 @@ public synchronized WritableComparable getClosest(WritableComparable key,
return nextKey;
}
- /** Close the map. */
+ /**
+ * Close the map.
+ * @throws IOException raised on errors performing I/O.
+ */
@Override
public synchronized void close() throws IOException {
if (!indexClosed) {
@@ -741,7 +888,13 @@ public synchronized void close() throws IOException {
}
- /** Renames an existing map directory. */
+ /**
+ * Renames an existing map directory.
+ * @param fs fs.
+ * @param oldName oldName.
+ * @param newName newName.
+ * @throws IOException raised on errors performing I/O.
+ */
public static void rename(FileSystem fs, String oldName, String newName)
throws IOException {
Path oldDir = new Path(oldName);
@@ -751,7 +904,12 @@ public static void rename(FileSystem fs, String oldName, String newName)
}
}
- /** Deletes the named map file. */
+ /**
+ * Deletes the named map file.
+ * @param fs input fs.
+ * @param name input name.
+ * @throws IOException raised on errors performing I/O.
+ */
public static void delete(FileSystem fs, String name) throws IOException {
Path dir = new Path(name);
Path data = new Path(dir, DATA_FILE_NAME);
@@ -769,8 +927,9 @@ public static void delete(FileSystem fs, String name) throws IOException {
* @param keyClass key class (has to be a subclass of Writable)
* @param valueClass value class (has to be a subclass of Writable)
* @param dryrun do not perform any changes, just report what needs to be done
+ * @param conf configuration.
* @return number of valid entries in this MapFile, or -1 if no fixing was needed
- * @throws Exception
+ * @throws Exception Exception.
*/
public static long fix(FileSystem fs, Path dir,
Class keyClass,
@@ -870,11 +1029,12 @@ public Merger(Configuration conf) throws IOException {
}
/**
- * Merge multiple MapFiles to one Mapfile
+ * Merge multiple MapFiles to one Mapfile.
*
- * @param inMapFiles
- * @param outMapFile
- * @throws IOException
+ * @param inMapFiles input inMapFiles.
+ * @param deleteInputs deleteInputs.
+ * @param outMapFile input outMapFile.
+ * @throws IOException raised on errors performing I/O.
*/
public void merge(Path[] inMapFiles, boolean deleteInputs,
Path outMapFile) throws IOException {
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/MultipleIOException.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/MultipleIOException.java
index c9d7ade43064f..452965b7c8220 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/MultipleIOException.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/MultipleIOException.java
@@ -42,7 +42,11 @@ private MultipleIOException(ListThis always returns a synchronized position. In other words, * immediately after calling {@link SequenceFile.Reader#seek(long)} with a position * returned by this method, {@link SequenceFile.Reader#next(Writable)} may be called. However * the key may be earlier in the file than key last written when this * method was called (e.g., with block-compression, it may be the first key - * in the block that was being written when this method was called). + * in the block that was being written when this method was called).
+ * + * @throws IOException raised on errors performing I/O. */ public synchronized long getLength() throws IOException { return out.getPos(); @@ -1899,7 +1947,7 @@ public Reader(Configuration conf, Option... opts) throws IOException { * @param fs The file system used to open the file. * @param file The file being read. * @param conf Configuration - * @throws IOException + * @throws IOException raised on errors performing I/O. * @deprecated Use Reader(Configuration, Option...) instead. */ @Deprecated @@ -1915,7 +1963,7 @@ public Reader(FileSystem fs, Path file, * @param start The starting position. * @param length The length being read. * @param conf Configuration - * @throws IOException + * @throws IOException raised on errors performing I/O. * @deprecated Use Reader(Configuration, Reader.Option...) instead. */ @Deprecated @@ -1960,7 +2008,7 @@ private void initialize(Path filename, FSDataInputStream in, * @param length The length being read if it is {@literal >=} 0. * Otherwise, the length is not available. * @return The opened stream. - * @throws IOException + * @throws IOException raised on errors performing I/O. */ protected FSDataInputStream openFile(FileSystem fs, Path file, int bufferSize, long length) throws IOException { @@ -2150,12 +2198,12 @@ public synchronized void close() throws IOException { in.close(); } - /** Returns the name of the key class. */ + /** @return Returns the name of the key class. */ public String getKeyClassName() { return keyClassName; } - /** Returns the class of keys in this file. */ + /** @return Returns the class of keys in this file. */ public synchronized Class getKeyClass() { if (null == keyClass) { try { @@ -2167,12 +2215,12 @@ public synchronized Class getKeyClass() { return keyClass; } - /** Returns the name of the value class. */ + /** @return Returns the name of the value class. */ public String getValueClassName() { return valClassName; } - /** Returns the class of values in this file. */ + /** @return Returns the class of values in this file. */ public synchronized Class getValueClass() { if (null == valClass) { try { @@ -2184,13 +2232,22 @@ public synchronized Class getValueClass() { return valClass; } - /** Returns true if values are compressed. */ + /** + * Returns true if values are compressed. + * @return if values are compressed true, not false. + */ public boolean isCompressed() { return decompress; } - /** Returns true if records are block-compressed. */ + /** + * Returns true if records are block-compressed. + * @return if records are block-compressed true, not false. + */ public boolean isBlockCompressed() { return blockCompressed; } - /** Returns the compression codec of data in this file. */ + /** + * Returns the compression codec of data in this file. + * @return CompressionCodec. + */ public CompressionCodec getCompressionCodec() { return codec; } private byte[] getSync() { @@ -2213,7 +2270,10 @@ public CompressionType getCompressionType() { } } - /** Returns the metadata object of the file */ + /** + * Returns the metadata object of the file. + * @return metadata. + */ public Metadata getMetadata() { return this.metadata; } @@ -2322,7 +2382,7 @@ private synchronized void seekToCurrentValue() throws IOException { /** * Get the 'value' corresponding to the last read 'key'. * @param val : The 'value' to be read. - * @throws IOException + * @throws IOException raised on errors performing I/O. */ public synchronized void getCurrentValue(Writable val) throws IOException { @@ -2359,9 +2419,9 @@ public synchronized void getCurrentValue(Writable val) } /** - * Get the 'value' corresponding to the last read 'key'. + * @return Get the 'value' corresponding to the last read 'key'. * @param val : The 'value' to be read. - * @throws IOException + * @throws IOException raised on errors performing I/O. */ public synchronized Object getCurrentValue(Object val) throws IOException { @@ -2403,8 +2463,13 @@ private Object deserializeValue(Object val) throws IOException { return valDeserializer.deserialize(val); } - /** Read the next key in the file intokey, skipping its
- * value. True if another entry exists, and false at end of file. */
+ /**
+ * @return Read the next key in the file into key, skipping its
+ * value.True if another entry exists, and false at end of file.
+ *
+ * @param key key.
+ * @throws IOException raised on errors performing I/O.
+ */
public synchronized boolean next(Writable key) throws IOException {
if (key.getClass() != getKeyClass())
throw new IOException("wrong key class: "+key.getClass().getName()
@@ -2451,9 +2516,16 @@ public synchronized boolean next(Writable key) throws IOException {
return true;
}
- /** Read the next key/value pair in the file into key and
- * val. Returns true if such a pair exists and false when at
- * end of file */
+ /**
+ * Read the next key/value pair in the file into key and
+ * val.
+ * @return Returns true if such a pair exists and false when at
+ * end of file.
+ *
+ * @param key input key.
+ * @param val input val.
+ * @throws IOException raised on errors performing I/O.
+ */
public synchronized boolean next(Writable key, Writable val)
throws IOException {
if (val.getClass() != getValueClass())
@@ -2537,7 +2609,7 @@ public ValueBytes createValueBytes() {
* @param key - The buffer into which the key is read
* @param val - The 'raw' value
* @return Returns the total record length or -1 for end of file
- * @throws IOException
+ * @throws IOException raised on errors performing I/O.
*/
public synchronized int nextRaw(DataOutputBuffer key, ValueBytes val)
throws IOException {
@@ -2596,7 +2668,7 @@ public synchronized int nextRaw(DataOutputBuffer key, ValueBytes val)
* Read 'raw' keys.
* @param key - The buffer into which the key is read
* @return Returns the key length or -1 for end of file
- * @throws IOException
+ * @throws IOException raised on errors performing I/O.
*/
public synchronized int nextRawKey(DataOutputBuffer key)
throws IOException {
@@ -2635,8 +2707,14 @@ public synchronized int nextRawKey(DataOutputBuffer key)
}
- /** Read the next key in the file, skipping its
- * value. Return null at end of file. */
+ /**
+ * Read the next key in the file, skipping its
+ * value.
+ *
+ * @param key input Object key.
+ * @throws IOException raised on errors performing I/O.
+ * @return Return null at end of file.
+ */
public synchronized Object next(Object key) throws IOException {
if (key != null && key.getClass() != getKeyClass()) {
throw new IOException("wrong key class: "+key.getClass().getName()
@@ -2693,7 +2771,7 @@ private Object deserializeKey(Object key) throws IOException {
* Read 'raw' values.
* @param val - The 'raw' value
* @return Returns the value length
- * @throws IOException
+ * @throws IOException raised on errors performing I/O.
*/
public synchronized int nextRawValue(ValueBytes val)
throws IOException {
@@ -2733,16 +2811,20 @@ private void handleChecksumException(ChecksumException e)
}
}
- /** disables sync. often invoked for tmp files */
+ /** disables sync. often invoked for tmp files. */
synchronized void ignoreSync() {
sync = null;
}
- /** Set the current byte position in the input file.
+ /**
+ * Set the current byte position in the input file.
*
* The position passed must be a position returned by {@link * SequenceFile.Writer#getLength()} when writing this file. To seek to an arbitrary - * position, use {@link SequenceFile.Reader#sync(long)}. + * position, use {@link SequenceFile.Reader#sync(long)}.
+ * + * @param position input position. + * @throws IOException raised on errors performing I/O. */ public synchronized void seek(long position) throws IOException { in.seek(position); @@ -2752,7 +2834,11 @@ public synchronized void seek(long position) throws IOException { } } - /** Seek to the next sync mark past a given position.*/ + /** + * Seek to the next sync mark past a given position. + * @param position position. + * @throws IOException raised on errors performing I/O. + */ public synchronized void sync(long position) throws IOException { if (position+SYNC_SIZE >= end) { seek(end); @@ -2788,10 +2874,13 @@ public synchronized void sync(long position) throws IOException { } } - /** Returns true iff the previous call to next passed a sync mark.*/ + /** @return Returns true iff the previous call to next passed a sync mark.*/ public synchronized boolean syncSeen() { return syncSeen; } - /** Return the current byte position in the input file. */ + /** + * @return Return the current byte position in the input file. + * @throws IOException raised on errors performing I/O. + */ public synchronized long getPosition() throws IOException { return in.getPos(); } @@ -2833,19 +2922,40 @@ public static class Sorter { private Progressable progressable = null; - /** Sort and merge files containing the named classes. */ + /** + * Sort and merge files containing the named classes. + * @param fs input FileSystem. + * @param keyClass input keyClass. + * @param valClass input valClass. + * @param conf input Configuration. + */ public Sorter(FileSystem fs, Class keyClass, Class valClass, Configuration conf) { this(fs, WritableComparator.get(keyClass, conf), keyClass, valClass, conf); } - /** Sort and merge using an arbitrary {@link RawComparator}. */ + /** + * Sort and merge using an arbitrary {@link RawComparator}. + * @param fs input FileSystem. + * @param comparator input RawComparator. + * @param keyClass input keyClass. + * @param valClass input valClass. + * @param conf input Configuration. + */ public Sorter(FileSystem fs, RawComparator comparator, Class keyClass, Class valClass, Configuration conf) { this(fs, comparator, keyClass, valClass, conf, new Metadata()); } - /** Sort and merge using an arbitrary {@link RawComparator}. */ + /** + * Sort and merge using an arbitrary {@link RawComparator}. + * @param fs input FileSystem. + * @param comparator input RawComparator. + * @param keyClass input keyClass. + * @param valClass input valClass. + * @param conf input Configuration. + * @param metadata input metadata. + */ @SuppressWarnings("deprecation") public Sorter(FileSystem fs, RawComparator comparator, Class keyClass, Class valClass, Configuration conf, Metadata metadata) { @@ -2874,19 +2984,28 @@ public Sorter(FileSystem fs, RawComparator comparator, Class keyClass, this.metadata = metadata; } - /** Set the number of streams to merge at once.*/ + /** + * Set the number of streams to merge at once. + * @param factor factor. + */ public void setFactor(int factor) { this.factor = factor; } - /** Get the number of streams to merge at once.*/ + /** @return Get the number of streams to merge at once.*/ public int getFactor() { return factor; } - /** Set the total amount of buffer memory, in bytes.*/ + /** + * Set the total amount of buffer memory, in bytes. + * @param memory buffer memory. + */ public void setMemory(int memory) { this.memory = memory; } - /** Get the total amount of buffer memory, in bytes.*/ + /** @return Get the total amount of buffer memory, in bytes.*/ public int getMemory() { return memory; } - /** Set the progressable object in order to report progress. */ + /** + * Set the progressable object in order to report progress. + * @param progressable input Progressable. + */ public void setProgressable(Progressable progressable) { this.progressable = progressable; } @@ -2896,6 +3015,7 @@ public void setProgressable(Progressable progressable) { * @param inFiles the files to be sorted * @param outFile the sorted output file * @param deleteInput should the input files be deleted as they are read? + * @throws IOException raised on errors performing I/O. */ public void sort(Path[] inFiles, Path outFile, boolean deleteInput) throws IOException { @@ -2918,6 +3038,7 @@ public void sort(Path[] inFiles, Path outFile, * @param tempDir the directory where temp files are created during sort * @param deleteInput should the input files be deleted as they are read? * @return iterator the RawKeyValueIterator + * @throws IOException raised on errors performing I/O. */ public RawKeyValueIterator sortAndIterate(Path[] inFiles, Path tempDir, boolean deleteInput) throws IOException { @@ -2943,8 +3064,9 @@ else if (segments == 1) /** * The backwards compatible interface to sort. - * @param inFile the input file to sort - * @param outFile the sorted output file + * @param inFile the input file to sort. + * @param outFile the sorted output file. + * @throws IOException raised on errors performing I/O. */ public void sort(Path inFile, Path outFile) throws IOException { sort(new Path[]{inFile}, outFile, false); @@ -3162,27 +3284,32 @@ public void setProgressable(Progressable progressable) /** The interface to iterate over raw keys/values of SequenceFiles. */ public static interface RawKeyValueIterator { - /** Gets the current raw key + /** + * Gets the current raw key. * @return DataOutputBuffer - * @throws IOException + * @throws IOException raised on errors performing I/O. */ DataOutputBuffer getKey() throws IOException; - /** Gets the current raw value + /** + * Gets the current raw value. * @return ValueBytes - * @throws IOException + * @throws IOException raised on errors performing I/O. */ ValueBytes getValue() throws IOException; - /** Sets up the current key and value (for getKey and getValue) + /** + * Sets up the current key and value (for getKey and getValue). * @return true if there exists a key/value, false otherwise - * @throws IOException + * @throws IOException raised on errors performing I/O. */ boolean next() throws IOException; - /** closes the iterator so that the underlying streams can be closed - * @throws IOException + /** + * closes the iterator so that the underlying streams can be closed. + * @throws IOException raised on errors performing I/O. */ void close() throws IOException; - /** Gets the Progress object; this has a float (0.0 - 1.0) - * indicating the bytes processed by the iterator so far + /** + * @return Gets the Progress object; this has a float (0.0 - 1.0) + * indicating the bytes processed by the iterator so far. */ Progress getProgress(); } @@ -3192,7 +3319,7 @@ public static interface RawKeyValueIterator { * @param segments the list of SegmentDescriptors * @param tmpDir the directory to write temporary files into * @return RawKeyValueIterator - * @throws IOException + * @throws IOException raised on errors performing I/O. */ public RawKeyValueIterator merge(Listkey. Returns
- * true if such a key exists and false when at the end of the set. */
+ /**
+ * Read the next key in a set into key.
+ *
+ * @param key input key.
+ * @return Returns true if such a key exists
+ * and false when at the end of the set.
+ * @throws IOException raised on errors performing I/O.
+ */
public boolean next(WritableComparable key)
throws IOException {
return next(key, NullWritable.get());
}
- /** Read the matching key from a set into key.
- * Returns key, or null if no match exists. */
+ /**
+ * Read the matching key from a set into key.
+ *
+ * @param key input key.
+ * @return Returns key, or null if no match exists.
+ * @throws IOException raised on errors performing I/O.
+ */
public WritableComparable get(WritableComparable key)
throws IOException {
if (seek(key)) {
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/ShortWritable.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/ShortWritable.java
index be09df18017b7..96e6cacae8773 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/ShortWritable.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/ShortWritable.java
@@ -38,12 +38,15 @@ public ShortWritable(short value) {
set(value);
}
- /** Set the value of this ShortWritable. */
+ /**
+ * Set the value of this ShortWritable.
+ * @param value input value.
+ */
public void set(short value) {
this.value = value;
}
- /** Return the value of this ShortWritable. */
+ /** @return Return the value of this ShortWritable. */
public short get() {
return value;
}
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/Text.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/Text.java
index 3ab327fe76a30..d180c88bcbd37 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/Text.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/Text.java
@@ -82,25 +82,32 @@ public Text() {
bytes = EMPTY_BYTES;
}
- /** Construct from a string.
+ /**
+ * Construct from a string.
+ * @param string input string.
*/
public Text(String string) {
set(string);
}
- /** Construct from another text. */
+ /**
+ * Construct from another text.
+ * @param utf8 input utf8.
+ */
public Text(Text utf8) {
set(utf8);
}
- /** Construct from a byte array.
+ /**
+ * Construct from a byte array.
+ * @param utf8 input utf8.
*/
public Text(byte[] utf8) {
set(utf8);
}
/**
- * Get a copy of the bytes that is exactly the length of the data.
+ * @return Get a copy of the bytes that is exactly the length of the data.
* See {@link #getBytes()} for faster access to the underlying array.
*/
public byte[] copyBytes() {
@@ -128,10 +135,12 @@ public int getLength() {
/**
* Returns the Unicode Scalar Value (32-bit integer value)
* for the character at position. Note that this
- * method avoids using the converter or doing String instantiation
+ * method avoids using the converter or doing String instantiation.
+ *
+ * @param position input position.
* @return the Unicode scalar value at position or -1
* if the position is invalid or points to a
- * trailing byte
+ * trailing byte.
*/
public int charAt(int position) {
if (position > this.length) return -1; // too long
@@ -151,6 +160,9 @@ public int find(String what) {
* 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.
+ *
+ * @param what input what.
+ * @param start input start.
* @return byte position of the first occurrence of the search
* string in the UTF-8 buffer or -1 if not found
*/
@@ -191,7 +203,9 @@ public int find(String what, int start) {
return -1;
}
}
- /** Set to contain the contents of a string.
+ /**
+ * Set to contain the contents of a string.
+ * @param string input string.
*/
public void set(String string) {
try {
@@ -203,13 +217,18 @@ public void set(String string) {
}
}
- /** Set to a utf8 byte array
+ /**
+ * Set to a utf8 byte array.
+ * @param utf8 input utf8.
*/
public void set(byte[] utf8) {
set(utf8, 0, utf8.length);
}
- /** copy a text. */
+ /**
+ * copy a text.
+ * @param other input other.
+ */
public void set(Text other) {
set(other.getBytes(), 0, other.getLength());
}
@@ -303,7 +322,11 @@ public void readFields(DataInput in, int maxLength) throws IOException {
readWithKnownLength(in, newLength);
}
- /** Skips over one Text in the input. */
+ /**
+ * Skips over one Text in the input.
+ * @param in input in.
+ * @throws IOException raised on errors performing I/O.
+ */
public static void skip(DataInput in) throws IOException {
int length = WritableUtils.readVInt(in);
WritableUtils.skipFully(in, length);
@@ -313,6 +336,10 @@ public static void skip(DataInput in) throws IOException {
* Read a Text object whose length is already known.
* This allows creating Text from a stream which uses a different serialization
* format.
+ *
+ * @param in input in.
+ * @param len input len.
+ * @throws IOException raised on errors performing I/O.
*/
public void readWithKnownLength(DataInput in, int len) throws IOException {
setCapacity(len, false);
@@ -376,9 +403,13 @@ public int compare(byte[] b1, int s1, int l1,
/// STATIC UTILITIES FROM HERE DOWN
/**
- * Converts the provided byte array to a String using the
+ * @return Converts the provided byte array to a String using the
* UTF-8 encoding. If the input is malformed,
* replace by a default value.
+ *
+ * @param utf8 input utf8.
+ * @throws CharacterCodingException a character encoding or
+ * decoding error occurs.
*/
public static String decode(byte[] utf8) throws CharacterCodingException {
return decode(ByteBuffer.wrap(utf8), true);
@@ -390,11 +421,18 @@ public static String decode(byte[] utf8, int start, int length)
}
/**
- * Converts the provided byte array to a String using the
+ * @return Converts the provided byte array to a String using the
* UTF-8 encoding. If replace is true, then
* malformed input is replaced with the
* substitution character, which is U+FFFD. Otherwise the
* method throws a MalformedInputException.
+ *
+ * @param utf8 input utf8.
+ * @param start input start.
+ * @param length input length.
+ * @param replace input replace.
+ * @throws CharacterCodingException a character encoding or
+ * decoding error occurs.
*/
public static String decode(byte[] utf8, int start, int length, boolean replace)
throws CharacterCodingException {
@@ -422,8 +460,12 @@ private static String decode(ByteBuffer utf8, boolean replace)
* Converts the provided String to bytes using the
* UTF-8 encoding. If the input is malformed,
* invalid chars are replaced by a default value.
+ *
+ * @param string input string.
* @return ByteBuffer: bytes stores at ByteBuffer.array()
* and length is ByteBuffer.limit()
+ * @throws CharacterCodingException
+ * a character encoding or decoding error occurs.
*/
public static ByteBuffer encode(String string)
@@ -437,8 +479,12 @@ public static ByteBuffer encode(String string)
* malformed input is replaced with the
* substitution character, which is U+FFFD. Otherwise the
* method throws a MalformedInputException.
+ *
+ * @param string input string.
+ * @param replace input replace.
* @return ByteBuffer: bytes stores at ByteBuffer.array()
* and length is ByteBuffer.limit()
+ * @throws CharacterCodingException a character encoding or decoding error occurs.
*/
public static ByteBuffer encode(String string, boolean replace)
throws CharacterCodingException {
@@ -458,13 +504,20 @@ public static ByteBuffer encode(String string, boolean replace)
static final public int DEFAULT_MAX_LEN = 1024 * 1024;
- /** Read a UTF8 encoded string from in
+ /**
+ * @return Read a UTF8 encoded string from in.
+ * @param in input in.
+ * @throws IOException raised on errors performing I/O.
*/
public static String readString(DataInput in) throws IOException {
return readString(in, Integer.MAX_VALUE);
}
- /** Read a UTF8 encoded string with a maximum size
+ /**
+ * @return Read a UTF8 encoded string with a maximum size.
+ * @param in input in.
+ * @param maxLength input maxLength.
+ * @throws IOException raised on errors performing I/O.
*/
public static String readString(DataInput in, int maxLength)
throws IOException {
@@ -474,7 +527,12 @@ public static String readString(DataInput in, int maxLength)
return decode(bytes);
}
- /** Write a UTF8 encoded string to out
+ /**
+ * @return Write a UTF8 encoded string to out.
+ *
+ * @param out input out.
+ * @param s input s.
+ * @throws IOException raised on errors performing I/O.
*/
public static int writeString(DataOutput out, String s) throws IOException {
ByteBuffer bytes = encode(s);
@@ -484,7 +542,13 @@ public static int writeString(DataOutput out, String s) throws IOException {
return length;
}
- /** Write a UTF8 encoded string with a maximum size to out
+ /**
+ * @return Write a UTF8 encoded string with a maximum size to out.
+ *
+ * @param out input out.
+ * @param s input s.
+ * @param maxLength input maxLength.
+ * @throws IOException raised on errors performing I/O.
*/
public static int writeString(DataOutput out, String s, int maxLength)
throws IOException {
@@ -616,9 +680,10 @@ public static void validateUTF8(byte[] utf8, int start, int len)
3, 3, 3, 3, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5 };
/**
- * Returns the next code point at the current position in
+ * @return Returns the next code point at the current position in
* the buffer. The buffer's position will be incremented.
* Any mark set on this buffer will be changed by this method!
+ * @param bytes input bytes.
*/
public static int bytesToCodePoint(ByteBuffer bytes) {
bytes.mark();
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/UTF8.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/UTF8.java
index f5d33a13005d7..fdee830e6fea8 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/UTF8.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/UTF8.java
@@ -63,27 +63,36 @@ public UTF8() {
//set("");
}
- /** Construct from a given string. */
+ /**
+ * Construct from a given string.
+ * @param string input string.
+ */
public UTF8(String string) {
set(string);
}
- /** Construct from a given string. */
+ /**
+ * Construct from a given string.
+ * @param utf8 input utf8.
+ */
public UTF8(UTF8 utf8) {
set(utf8);
}
- /** The raw bytes. */
+ /** @return The raw bytes. */
public byte[] getBytes() {
return bytes;
}
- /** The number of bytes in the encoded string. */
+ /** @return The number of bytes in the encoded string. */
public int getLength() {
return length;
}
- /** Set to contain the contents of a string. */
+ /**
+ * Set to contain the contents of a string.
+ * @param string input string.
+ */
public void set(String string) {
if (string.length() > 0xffff/3) { // maybe too long
LOG.warn("truncating long string: " + string.length()
@@ -108,7 +117,10 @@ public void set(String string) {
}
}
- /** Set to contain the contents of a string. */
+ /**
+ * Set to contain the contents of a string.
+ * @param other input other.
+ */
public void set(UTF8 other) {
length = other.length;
if (bytes == null || length > bytes.length) // grow buffer
@@ -124,7 +136,11 @@ public void readFields(DataInput in) throws IOException {
in.readFully(bytes, 0, length);
}
- /** Skips over one UTF8 in the input. */
+ /**
+ * Skips over one UTF8 in the input.
+ * @param in datainput.
+ * @throws IOException raised on errors performing I/O.
+ */
public static void skip(DataInput in) throws IOException {
int length = in.readUnsignedShort();
WritableUtils.skipFully(in, length);
@@ -214,8 +230,10 @@ public int compare(byte[] b1, int s1, int l1,
/// These are probably not used much anymore, and might be removed...
- /** Convert a string to a UTF-8 encoded byte array.
+ /**
+ * @return Convert a string to a UTF-8 encoded byte array.
* @see String#getBytes(String)
+ * @param string input string.
*/
public static byte[] getBytes(String string) {
byte[] result = new byte[utf8Length(string)];
@@ -231,8 +249,9 @@ public static byte[] getBytes(String string) {
}
/**
- * Convert a UTF-8 encoded byte array back into a string.
+ * @return Convert a UTF-8 encoded byte array back into a string.
*
+ * @param bytes input bytes.
* @throws IOException if the byte array is invalid UTF8
*/
public static String fromBytes(byte[] bytes) throws IOException {
@@ -243,9 +262,12 @@ public static String fromBytes(byte[] bytes) throws IOException {
return buf.toString();
}
- /** Read a UTF-8 encoded string.
+ /**
+ * @return Read a UTF-8 encoded string.
*
* @see DataInput#readUTF()
+ * @param in DataInput.
+ * @throws IOException raised on errors performing I/O.
*/
public static String readString(DataInput in) throws IOException {
int bytes = in.readUnsignedShort();
@@ -318,9 +340,13 @@ private static char lowSurrogate(int codePoint) {
return (char) ((codePoint & 0x3ff) + Character.MIN_LOW_SURROGATE);
}
- /** Write a UTF-8 encoded string.
+ /**
+ * @return Write a UTF-8 encoded string.
*
* @see DataOutput#writeUTF(String)
+ * @param out input out.
+ * @param s input s.
+ * @throws IOException raised on errors performing I/O.
*/
public static int writeString(DataOutput out, String s) throws IOException {
if (s.length() > 0xffff/3) { // maybe too long
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/VIntWritable.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/VIntWritable.java
index f537524c4b40a..7d3f680858ec3 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/VIntWritable.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/VIntWritable.java
@@ -37,10 +37,13 @@ public VIntWritable() {}
public VIntWritable(int value) { set(value); }
- /** Set the value of this VIntWritable. */
+ /**
+ * Set the value of this VIntWritable.
+ * @param value input value.
+ */
public void set(int value) { this.value = value; }
- /** Return the value of this VIntWritable. */
+ /** @return Return the value of this VIntWritable. */
public int get() { return value; }
@Override
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/VLongWritable.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/VLongWritable.java
index a9fac30605be6..a72a7fc2fd39a 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/VLongWritable.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/VLongWritable.java
@@ -37,10 +37,13 @@ public VLongWritable() {}
public VLongWritable(long value) { set(value); }
- /** Set the value of this LongWritable. */
+ /**
+ * Set the value of this LongWritable.
+ * @param value input value.
+ */
public void set(long value) { this.value = value; }
- /** Return the value of this LongWritable. */
+ /** @return Return the value of this LongWritable. */
public long get() { return value; }
@Override
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/VersionedWritable.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/VersionedWritable.java
index c2db55520c918..421b8daeeae8e 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/VersionedWritable.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/VersionedWritable.java
@@ -36,7 +36,7 @@
@InterfaceStability.Stable
public abstract class VersionedWritable implements Writable {
- /** Return the version number of the current implementation. */
+ /** @return Return the version number of the current implementation. */
public abstract byte getVersion();
// javadoc from Writable
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/Writable.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/Writable.java
index b94de6c3c72bd..56b46d554fee6 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/Writable.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/Writable.java
@@ -71,7 +71,7 @@ public interface Writable {
* Serialize the fields of this object to out.
*
* @param out DataOuput to serialize this object into.
- * @throws IOException
+ * @throws IOException any other problem for write.
*/
void write(DataOutput out) throws IOException;
@@ -82,7 +82,7 @@ public interface Writable {
* existing object where possible.
*
* @param in DataInput to deseriablize this object from.
- * @throws IOException
+ * @throws IOException any other problem for readFields.
*/
void readFields(DataInput in) throws IOException;
}
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableComparator.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableComparator.java
index 1754b8d06f6fa..05d4e3c5c533f 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableComparator.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableComparator.java
@@ -46,12 +46,22 @@ public class WritableComparator implements RawComparator, Configurable {
private Configuration conf;
- /** For backwards compatibility. **/
+ /**
+ * For backwards compatibility.
+ *
+ * @param c WritableComparable Type.
+ * @return WritableComparator.
+ */
public static WritableComparator get(Class c) {
return get(c, null);
}
- /** Get a comparator for a {@link WritableComparable} implementation. */
+ /**
+ * Get a comparator for a {@link WritableComparable} implementation.
+ * @param c class.
+ * @param conf configuration.
+ * @return WritableComparator.
+ */
public static WritableComparator get(
Class c, Configuration conf) {
WritableComparator comparator = comparators.get(c);
@@ -95,9 +105,13 @@ private static void forceInit(Class cls) {
}
}
- /** Register an optimized comparator for a {@link WritableComparable}
+ /**
+ * Register an optimized comparator for a {@link WritableComparable}
* implementation. Comparators registered with this method must be
- * thread-safe. */
+ * thread-safe.
+ * @param c class.
+ * @param comparator WritableComparator.
+ */
public static void define(Class c, WritableComparator comparator) {
comparators.put(c, comparator);
}
@@ -111,7 +125,10 @@ protected WritableComparator() {
this(null);
}
- /** Construct for a {@link WritableComparable} implementation. */
+ /**
+ * Construct for a {@link WritableComparable} implementation.
+ * @param keyClass WritableComparable Class.
+ */
protected WritableComparator(Class keyClass) {
this(keyClass, null, false);
}
@@ -136,10 +153,16 @@ protected WritableComparator(Class keyClass,
}
}
- /** Returns the WritableComparable implementation class. */
+ /**
+ * Returns the WritableComparable implementation class.
+ * @return WritableComparable.
+ */
public Class getKeyClass() { return keyClass; }
- /** Construct a new {@link WritableComparable} instance. */
+ /**
+ * Construct a new {@link WritableComparable} instance.
+ * @return WritableComparable.
+ */
public WritableComparable newKey() {
return ReflectionUtils.newInstance(keyClass, conf);
}
@@ -168,27 +191,54 @@ public int compare(byte[] b1, int s1, int l1, byte[] b2, int s2, int l2) {
return compare(key1, key2); // compare them
}
- /** Compare two WritableComparables.
+ /**
+ * Compare two WritableComparables.
*
- * The default implementation uses the natural ordering, calling {@link
- * Comparable#compareTo(Object)}. */
+ * The default implementation uses the natural ordering, calling {@link
+ * Comparable#compareTo(Object)}.
+ * @param a the first object to be compared.
+ * @param b the second object to be compared.
+ * @return compare result.
+ */
@SuppressWarnings("unchecked")
public int compare(WritableComparable a, WritableComparable b) {
return a.compareTo(b);
}
+ /**
+ * Compare two Object.
+ *
+ * @param a the first object to be compared.
+ * @param b the second object to be compared.
+ * @return compare result.
+ */
@Override
public int compare(Object a, Object b) {
return compare((WritableComparable)a, (WritableComparable)b);
}
- /** Lexicographic order of binary data. */
+ /**
+ * Lexicographic order of binary data.
+ * @param b1 b1.
+ * @param s1 s1.
+ * @param l1 l1.
+ * @param b2 b2.
+ * @param s2 s2.
+ * @param l2 l2.
+ * @return compare bytes.
+ */
public static int compareBytes(byte[] b1, int s1, int l1,
byte[] b2, int s2, int l2) {
return FastByteComparisons.compareTo(b1, s1, l1, b2, s2, l2);
}
- /** Compute hash for binary data. */
+ /**
+ * Compute hash for binary data.
+ * @param bytes bytes.
+ * @param offset offset.
+ * @param length length.
+ * @return hash for binary data.
+ */
public static int hashBytes(byte[] bytes, int offset, int length) {
int hash = 1;
for (int i = offset; i < offset + length; i++)
@@ -196,18 +246,33 @@ public static int hashBytes(byte[] bytes, int offset, int length) {
return hash;
}
- /** Compute hash for binary data. */
+ /**
+ * Compute hash for binary data.
+ * @param bytes bytes.
+ * @param length length.
+ * @return hash for binary data.
+ */
public static int hashBytes(byte[] bytes, int length) {
return hashBytes(bytes, 0, length);
}
- /** Parse an unsigned short from a byte array. */
+ /**
+ * Parse an unsigned short from a byte array.
+ * @param bytes bytes.
+ * @param start start.
+ * @return unsigned short from a byte array
+ */
public static int readUnsignedShort(byte[] bytes, int start) {
return (((bytes[start] & 0xff) << 8) +
((bytes[start+1] & 0xff)));
}
- /** Parse an integer from a byte array. */
+ /**
+ * Parse an integer from a byte array.
+ * @param bytes bytes.
+ * @param start start.
+ * @return integer from a byte array
+ */
public static int readInt(byte[] bytes, int start) {
return (((bytes[start ] & 0xff) << 24) +
((bytes[start+1] & 0xff) << 16) +
@@ -216,18 +281,33 @@ public static int readInt(byte[] bytes, int start) {
}
- /** Parse a float from a byte array. */
+ /**
+ * Parse a float from a byte array.
+ * @param bytes bytes.
+ * @param start start.
+ * @return float from a byte array
+ */
public static float readFloat(byte[] bytes, int start) {
return Float.intBitsToFloat(readInt(bytes, start));
}
- /** Parse a long from a byte array. */
+ /**
+ * Parse a long from a byte array.
+ * @param bytes bytes.
+ * @param start start.
+ * @return long from a byte array
+ */
public static long readLong(byte[] bytes, int start) {
return ((long)(readInt(bytes, start)) << 32) +
(readInt(bytes, start+4) & 0xFFFFFFFFL);
}
- /** Parse a double from a byte array. */
+ /**
+ * Parse a double from a byte array.
+ * @param bytes bytes.
+ * @param start start.
+ * @return double from a byte array.
+ */
public static double readDouble(byte[] bytes, int start) {
return Double.longBitsToDouble(readLong(bytes, start));
}
@@ -236,7 +316,7 @@ public static double readDouble(byte[] bytes, int start) {
* Reads a zero-compressed encoded long from a byte array and returns it.
* @param bytes byte array with decode long
* @param start starting index
- * @throws java.io.IOException
+ * @throws IOException raised on errors performing I/O.
* @return deserialized long
*/
public static long readVLong(byte[] bytes, int start) throws IOException {
@@ -261,7 +341,7 @@ public static long readVLong(byte[] bytes, int start) throws IOException {
* Reads a zero-compressed encoded integer from a byte array and returns it.
* @param bytes byte array with the encoded integer
* @param start start index
- * @throws java.io.IOException
+ * @throws IOException raised on errors performing I/O.
* @return deserialized integer
*/
public static int readVInt(byte[] bytes, int start) throws IOException {
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableFactories.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableFactories.java
index a8fdbfe98dfdc..9dd231e488780 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableFactories.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableFactories.java
@@ -35,17 +35,31 @@ public class WritableFactories {
private WritableFactories() {} // singleton
- /** Define a factory for a class. */
+ /**
+ * Define a factory for a class.
+ * @param c input c.
+ * @param factory input factory.
+ */
public static void setFactory(Class c, WritableFactory factory) {
CLASS_TO_FACTORY.put(c, factory);
}
- /** Define a factory for a class. */
+ /**
+ * Define a factory for a class.
+ * @param c input c.
+ * @return a factory for a class.
+ */
public static WritableFactory getFactory(Class c) {
return CLASS_TO_FACTORY.get(c);
}
- /** Create a new instance of a class with a defined factory. */
+ /**
+ * Create a new instance of a class with a defined factory.
+ *
+ * @param c input c.
+ * @param conf input configuration.
+ * @return a new instance of a class with a defined factory.
+ */
public static Writable newInstance(Class c, Configuration conf) {
WritableFactory factory = WritableFactories.getFactory(c);
if (factory != null) {
@@ -59,7 +73,11 @@ public static Writable newInstance(Class c, Configuration co
}
}
- /** Create a new instance of a class with a defined factory. */
+ /**
+ * Create a new instance of a class with a defined factory.
+ * @param c input c.
+ * @return a new instance of a class with a defined factory.
+ */
public static Writable newInstance(Class c) {
return newInstance(c, null);
}
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableFactory.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableFactory.java
index bb8af974f051e..d9e9b543c7d96 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableFactory.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableFactory.java
@@ -27,7 +27,7 @@
@InterfaceAudience.Public
@InterfaceStability.Stable
public interface WritableFactory {
- /** Return a new instance. */
+ /** @return Return a new instance. */
Writable newInstance();
}
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableName.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableName.java
index 43d396edad7ab..e5e74875225cc 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableName.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableName.java
@@ -45,19 +45,33 @@ public class WritableName {
private WritableName() {} // no public ctor
- /** Set the name that a class should be known as to something other than the
- * class name. */
+ /**
+ * Set the name that a class should be known as to something other than the
+ * class name.
+ *
+ * @param writableClass input writableClass.
+ * @param name input name.
+ */
public static synchronized void setName(Class writableClass, String name) {
CLASS_TO_NAME.put(writableClass, name);
NAME_TO_CLASS.put(name, writableClass);
}
- /** Add an alternate name for a class. */
+ /**
+ * Add an alternate name for a class.
+ * @param writableClass input writableClass.
+ * @param name input name.
+ */
public static synchronized void addName(Class writableClass, String name) {
NAME_TO_CLASS.put(name, writableClass);
}
- /** Return the name for a class. Default is {@link Class#getName()}. */
+ /**
+ * Return the name for a class.
+ * Default is {@link Class#getName()}.
+ * @param writableClass input writableClass.
+ * @return name for a class.
+ */
public static synchronized String getName(Class writableClass) {
String name = CLASS_TO_NAME.get(writableClass);
if (name != null)
@@ -65,7 +79,15 @@ public static synchronized String getName(Class writableClass) {
return writableClass.getName();
}
- /** Return the class for a name. Default is {@link Class#forName(String)}.*/
+ /**
+ * Return the class for a name.
+ * Default is {@link Class#forName(String)}.
+ *
+ * @param name input name.
+ * @param conf input configuration.
+ * @return class for a name.
+ * @throws IOException raised on errors performing I/O.
+ */
public static synchronized Class getClass(String name, Configuration conf
) throws IOException {
Class writableClass = NAME_TO_CLASS.get(name);
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableUtils.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableUtils.java
index 2062fb6fe3705..187398de0ec86 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableUtils.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/WritableUtils.java
@@ -208,7 +208,10 @@ public static void displayByteArray(byte[] record){
/**
* Make a copy of a writable object using serialization to a buffer.
+ *
+ * @param
| Memory usage by blocksize | - *||
|---|---|---|
| Blocksize | Compression * memory usage | Decompression * memory usage |
@@ -213,6 +210,10 @@ public class CBZip2OutputStream extends OutputStream implements BZip2Constants {
/**
* This method is accessible by subclasses for historical purposes. If you
* don't know what it does then you don't need it.
+ * @param len len.
+ * @param freq freq.
+ * @param alphaSize alphaSize.
+ * @param maxLen maxLen.
*/
protected static void hbMakeCodeLengths(char[] len, int[] freq,
int alphaSize, int maxLen) {
@@ -849,6 +850,7 @@ private void endCompression() throws IOException {
/**
* Returns the blocksize parameter specified at construction time.
+ * @return blocksize.
*/
public final int getBlockSize() {
return this.blockSize100k;
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/lz4/Lz4Decompressor.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/lz4/Lz4Decompressor.java
index 2b62ef78b2859..719d216abaed0 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/lz4/Lz4Decompressor.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/lz4/Lz4Decompressor.java
@@ -199,7 +199,7 @@ public synchronized boolean finished() {
* @param off Start offset of the data
* @param len Size of the buffer
* @return The actual number of bytes of uncompressed data.
- * @throws IOException
+ * @throws IOException raised on errors performing I/O.
*/
@Override
public synchronized int decompress(byte[] b, int off, int len)
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/snappy/SnappyDecompressor.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/snappy/SnappyDecompressor.java
index d3775e286e895..58987c4dda3de 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/snappy/SnappyDecompressor.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/snappy/SnappyDecompressor.java
@@ -187,7 +187,7 @@ public boolean finished() {
* @param off Start offset of the data
* @param len Size of the buffer
* @return The actual number of bytes of compressed data.
- * @throws IOException
+ * @throws IOException raised on errors performing I/O.
*/
@Override
public int decompress(byte[] b, int off, int len)
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zlib/ZlibCompressor.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zlib/ZlibCompressor.java
index da8a90bb3170e..89e05fc6d07be 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zlib/ZlibCompressor.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zlib/ZlibCompressor.java
@@ -240,6 +240,7 @@ public ZlibCompressor() {
/**
* Creates a new compressor, taking settings from the configuration.
+ * @param conf configuration.
*/
public ZlibCompressor(Configuration conf) {
this(ZlibFactory.getCompressionLevel(conf),
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zlib/ZlibDecompressor.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zlib/ZlibDecompressor.java
index f642d7713035d..c2615548d23ee 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zlib/ZlibDecompressor.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zlib/ZlibDecompressor.java
@@ -101,6 +101,8 @@ static boolean isNativeZlibLoaded() {
/**
* Creates a new decompressor.
+ * @param header header.
+ * @param directBufferSize directBufferSize.
*/
public ZlibDecompressor(CompressionHeader header, int directBufferSize) {
this.header = header;
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zlib/ZlibFactory.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zlib/ZlibFactory.java
index 7b3099819497f..6982ed6d8471a 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zlib/ZlibFactory.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zlib/ZlibFactory.java
@@ -66,7 +66,7 @@ public static void loadNativeZLib() {
/**
* Set the flag whether to use native library. Used for testing non-native
* libraries
- *
+ * @param isLoaded isLoaded.
*/
@VisibleForTesting
public static void setNativeZlibLoaded(final boolean isLoaded) {
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zstd/ZStandardCompressor.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zstd/ZStandardCompressor.java
index 8b1b6db086021..6ba7320652de3 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zstd/ZStandardCompressor.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zstd/ZStandardCompressor.java
@@ -84,6 +84,8 @@ public static int getRecommendedBufferSize() {
/**
* Creates a new compressor with the default compression level.
* Compressed data will be generated in ZStandard format.
+ * @param level level.
+ * @param bufferSize bufferSize.
*/
public ZStandardCompressor(int level, int bufferSize) {
this(level, bufferSize, bufferSize);
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zstd/ZStandardDecompressor.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zstd/ZStandardDecompressor.java
index adf2fe629f8f7..792547a62faea 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zstd/ZStandardDecompressor.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/zstd/ZStandardDecompressor.java
@@ -73,6 +73,7 @@ public ZStandardDecompressor() {
/**
* Creates a new decompressor.
+ * @param bufferSize bufferSize.
*/
public ZStandardDecompressor(int bufferSize) {
this.directBufferSize = bufferSize;
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/CodecUtil.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/CodecUtil.java
index c871ce3067e00..85aebd8c74bf5 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/CodecUtil.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/CodecUtil.java
@@ -83,6 +83,7 @@ private CodecUtil() { }
/**
* Create encoder corresponding to given codec.
* @param options Erasure codec options
+ * @param conf configuration.
* @return erasure encoder
*/
public static ErasureEncoder createEncoder(Configuration conf,
@@ -100,6 +101,7 @@ public static ErasureEncoder createEncoder(Configuration conf,
/**
* Create decoder corresponding to given codec.
* @param options Erasure codec options
+ * @param conf configuration.
* @return erasure decoder
*/
public static ErasureDecoder createDecoder(Configuration conf,
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/ErasureCodeNative.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/ErasureCodeNative.java
index ec317eee4dc3e..83a3151282096 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/ErasureCodeNative.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/ErasureCodeNative.java
@@ -61,6 +61,7 @@ private ErasureCodeNative() {}
/**
* Are native libraries loaded?
+ * @return if is native code loaded true,not false.
*/
public static boolean isNativeCodeLoaded() {
return LOADING_FAILURE_REASON == null;
@@ -82,6 +83,7 @@ public static void checkNativeCodeLoaded() {
/**
* Get the native library name that's available or supported.
+ * @return library name.
*/
public static native String getLibraryName();
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureCoder.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureCoder.java
index b5ae1f1e399a8..ab1775538bd5f 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureCoder.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureCoder.java
@@ -68,6 +68,7 @@ public interface ErasureCoder extends Configurable {
*
* @param blockGroup the erasure coding block group containing all necessary
* information for codec calculation
+ * @return ErasureCodingStep.
*/
ErasureCodingStep calculateCoding(ECBlockGroup blockGroup);
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureCodingStep.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureCodingStep.java
index fb89d99a0540c..333647c982b9f 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureCodingStep.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureCodingStep.java
@@ -46,8 +46,9 @@ public interface ErasureCodingStep {
/**
* Perform encoding or decoding given the input chunks, and generated results
* will be written to the output chunks.
- * @param inputChunks
- * @param outputChunks
+ * @param inputChunks inputChunks.
+ * @param outputChunks outputChunks.
+ * @throws IOException raised on errors performing I/O.
*/
void performCoding(ECChunk[] inputChunks, ECChunk[] outputChunks)
throws IOException;
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureDecoder.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureDecoder.java
index faf44d944eeaf..a046d106f0ed1 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureDecoder.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureDecoder.java
@@ -65,7 +65,7 @@ public ErasureCoderOptions getOptions() {
/**
* We have all the data blocks and parity blocks as input blocks for
* recovering by default. It's codec specific
- * @param blockGroup
+ * @param blockGroup blockGroup.
* @return input blocks
*/
protected ECBlock[] getInputBlocks(ECBlockGroup blockGroup) {
@@ -83,7 +83,7 @@ protected ECBlock[] getInputBlocks(ECBlockGroup blockGroup) {
/**
* Which blocks were erased ?
- * @param blockGroup
+ * @param blockGroup blockGroup.
* @return output blocks to recover
*/
protected ECBlock[] getOutputBlocks(ECBlockGroup blockGroup) {
@@ -118,7 +118,7 @@ public void release() {
/**
* Perform decoding against a block blockGroup.
- * @param blockGroup
+ * @param blockGroup blockGroup.
* @return decoding step for caller to do the real work
*/
protected abstract ErasureCodingStep prepareDecodingStep(
@@ -126,7 +126,7 @@ protected abstract ErasureCodingStep prepareDecodingStep(
/**
* Get the number of erased blocks in the block group.
- * @param blockGroup
+ * @param blockGroup blockGroup.
* @return number of erased blocks
*/
protected int getNumErasedBlocks(ECBlockGroup blockGroup) {
@@ -153,7 +153,7 @@ protected static int getNumErasedBlocks(ECBlock[] inputBlocks) {
/**
* Get indexes of erased blocks from inputBlocks
- * @param inputBlocks
+ * @param inputBlocks inputBlocks.
* @return indexes of erased blocks from inputBlocks
*/
protected int[] getErasedIndexes(ECBlock[] inputBlocks) {
@@ -174,8 +174,8 @@ protected int[] getErasedIndexes(ECBlock[] inputBlocks) {
}
/**
- * Get erased input blocks from inputBlocks
- * @param inputBlocks
+ * Get erased input blocks from inputBlocks.
+ * @param inputBlocks input inputBlocks.
* @return an array of erased blocks from inputBlocks
*/
protected ECBlock[] getErasedBlocks(ECBlock[] inputBlocks) {
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureDecodingStep.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureDecodingStep.java
index 24f55470e1727..20a396d313678 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureDecodingStep.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureDecodingStep.java
@@ -37,10 +37,10 @@ public class ErasureDecodingStep implements ErasureCodingStep {
/**
* The constructor with all the necessary info.
- * @param inputBlocks
+ * @param inputBlocks inputBlocks.
* @param erasedIndexes the indexes of erased blocks in inputBlocks array
- * @param outputBlocks
- * @param rawDecoder
+ * @param outputBlocks outputBlocks.
+ * @param rawDecoder rawDecoder.
*/
public ErasureDecodingStep(ECBlock[] inputBlocks, int[] erasedIndexes,
ECBlock[] outputBlocks,
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureEncoder.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureEncoder.java
index 81666e9b76b2e..cca272f69a28d 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureEncoder.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureEncoder.java
@@ -83,7 +83,7 @@ public void release() {
/**
* Perform encoding against a block group.
- * @param blockGroup
+ * @param blockGroup blockGroup.
* @return encoding step for caller to do the real work
*/
protected abstract ErasureCodingStep prepareEncodingStep(
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureEncodingStep.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureEncodingStep.java
index 5fc5c7a09928f..9e696d2c58477 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureEncodingStep.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureEncodingStep.java
@@ -36,9 +36,9 @@ public class ErasureEncodingStep implements ErasureCodingStep {
/**
* The constructor with all the necessary info.
- * @param inputBlocks
- * @param outputBlocks
- * @param rawEncoder
+ * @param inputBlocks inputBlocks.
+ * @param outputBlocks outputBlocks.
+ * @param rawEncoder rawEncoder.
*/
public ErasureEncodingStep(ECBlock[] inputBlocks, ECBlock[] outputBlocks,
RawErasureEncoder rawEncoder) {
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/HHErasureCodingStep.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/HHErasureCodingStep.java
index a0f5b72710679..46f0a76da17df 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/HHErasureCodingStep.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/HHErasureCodingStep.java
@@ -38,8 +38,8 @@ public abstract class HHErasureCodingStep
/**
* Constructor given input blocks and output blocks.
*
- * @param inputBlocks
- * @param outputBlocks
+ * @param inputBlocks inputBlocks.
+ * @param outputBlocks outputBlocks.
*/
public HHErasureCodingStep(ECBlock[] inputBlocks,
ECBlock[] outputBlocks) {
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/HHXORErasureDecodingStep.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/HHXORErasureDecodingStep.java
index 16a3c0fa61c4b..4d594f476dfd9 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/HHXORErasureDecodingStep.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/HHXORErasureDecodingStep.java
@@ -43,9 +43,9 @@ public class HHXORErasureDecodingStep extends HHErasureCodingStep {
/**
* The constructor with all the necessary info.
- * @param inputBlocks
+ * @param inputBlocks inputBlocks.
* @param erasedIndexes the indexes of erased blocks in inputBlocks array
- * @param outputBlocks
+ * @param outputBlocks outputBlocks.
* @param rawDecoder underlying RS decoder for hitchhiker decoding
* @param rawEncoder underlying XOR encoder for hitchhiker decoding
*/
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/HHXORErasureEncodingStep.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/HHXORErasureEncodingStep.java
index 6a5644270117b..f571e932b6a85 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/HHXORErasureEncodingStep.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/HHXORErasureEncodingStep.java
@@ -40,8 +40,8 @@ public class HHXORErasureEncodingStep extends HHErasureCodingStep {
/**
* The constructor with all the necessary info.
*
- * @param inputBlocks
- * @param outputBlocks
+ * @param inputBlocks inputBlocks.
+ * @param outputBlocks outputBlocks.
* @param rsRawEncoder underlying RS encoder for hitchhiker encoding
* @param xorRawEncoder underlying XOR encoder for hitchhiker encoding
*/
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/XORErasureDecoder.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/XORErasureDecoder.java
index 1a0e5c030e070..9aae5e43c86f7 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/XORErasureDecoder.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/XORErasureDecoder.java
@@ -53,7 +53,7 @@ protected ErasureCodingStep prepareDecodingStep(
/**
* Which blocks were erased ? For XOR it's simple we only allow and return one
* erased block, either data or parity.
- * @param blockGroup
+ * @param blockGroup blockGroup.
* @return output blocks to recover
*/
@Override
diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/util/HHUtil.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/util/HHUtil.java
index 91d02415bfd93..7f771c9677da8 100644
--- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/util/HHUtil.java
+++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/util/HHUtil.java
@@ -202,6 +202,8 @@ public static ByteBuffer getPiggyBackForDecode(ByteBuffer[][] inputs,
/**
* Find the valid input from all the inputs.
+ *
+ * @param