big-data/hadoop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

HADOOP-11775. Fix Javadoc typos in hadoop-openstack module (Yanjun Wang via aw)

Browse Source
This commit is contained in:
Allen Wittenauer 2015-05-08 17:01:08 -07:00
parent 08f0ae403c
commit ed0f4db0dd
15 changed files with 27 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
hadoop-common-project/hadoop-common/CHANGES.txt
View File

@ -457,6 +457,9 @@ Trunk (Unreleased)
HADOOP-11865. Incorrect path mentioned in document for accessing script HADOOP-11865. Incorrect path mentioned in document for accessing script
files (J.Andreina via aw) files (J.Andreina via aw)
HADOOP-11775. Fix Javadoc typos in hadoop-openstack module (Yanjun Wang
via aw)
OPTIMIZATIONS OPTIMIZATIONS
HADOOP-7761. Improve the performance of raw comparisons. (todd) HADOOP-7761. Improve the performance of raw comparisons. (todd)

2
hadoop-tools/hadoop-openstack/src/main/java/org/apache/hadoop/fs/swift/http/ExceptionDiags.java
View File

@ -29,7 +29,7 @@
import java.net.UnknownHostException; import java.net.UnknownHostException;
/** /**
* Variant of Hadoop Netutils exception wrapping with URI awareness and * Variant of Hadoop NetUtils exception wrapping with URI awareness and
* available in branch-1 too. * available in branch-1 too.
*/ */
public class ExceptionDiags { public class ExceptionDiags {

2
hadoop-tools/hadoop-openstack/src/main/java/org/apache/hadoop/fs/swift/http/HttpBodyContent.java
View File

@ -26,7 +26,7 @@ public class HttpBodyContent {
/** /**
* build a body response * build a body response
* @param inputStream input stream from the operatin * @param inputStream input stream from the operation
* @param contentLength length of content; may be -1 for "don't know" * @param contentLength length of content; may be -1 for "don't know"
*/ */
public HttpBodyContent(HttpInputStreamWithRelease inputStream, public HttpBodyContent(HttpInputStreamWithRelease inputStream,

4
hadoop-tools/hadoop-openstack/src/main/java/org/apache/hadoop/fs/swift/http/SwiftProtocolConstants.java
View File

@ -66,7 +66,7 @@ public class SwiftProtocolConstants {
*/ */
public static final String SERVICE_CATALOG_SWIFT = "swift"; public static final String SERVICE_CATALOG_SWIFT = "swift";
/** /**
* section in the JSON catalog provided after auth listing the cloudfiles; * section in the JSON catalog provided after auth listing the cloud files;
* this is an alternate catalog entry name * this is an alternate catalog entry name
* {@value} * {@value}
*/ */
@ -185,7 +185,7 @@ public class SwiftProtocolConstants {
FS_SWIFT + ".requestsize"; FS_SWIFT + ".requestsize";
/** /**
* The default reqeuest size for reads: {@value} * The default request size for reads: {@value}
*/ */
public static final int DEFAULT_SWIFT_REQUEST_SIZE = 64; public static final int DEFAULT_SWIFT_REQUEST_SIZE = 64;

6
hadoop-tools/hadoop-openstack/src/main/java/org/apache/hadoop/fs/swift/http/SwiftRestClient.java
View File

@ -83,7 +83,7 @@
* This implements the client-side of the Swift REST API * This implements the client-side of the Swift REST API
* *
* The core actions put, get and query data in the Swift object store, * The core actions put, get and query data in the Swift object store,
* after authenticationg the client. * after authenticating the client.
* *
* <b>Logging:</b> * <b>Logging:</b>
* *
@ -1572,7 +1572,7 @@ private static StringRequestEntity toJsonEntity(String data) throws
* This is public for unit testing * This is public for unit testing
* *
* @param path path to object * @param path path to object
* @param endpointURI damain url e.g. http://domain.com * @param endpointURI domain url e.g. http://domain.com
* @return valid URI for object * @return valid URI for object
* @throws SwiftException * @throws SwiftException
*/ */
@ -1653,7 +1653,7 @@ private void setAuthToken(HttpMethodBase method, AccessToken accessToken)
* Execute a method in a new HttpClient instance. * Execute a method in a new HttpClient instance.
* If the auth failed, authenticate then retry the method. * If the auth failed, authenticate then retry the method.
* *
* @param method methot to exec * @param method method to exec
* @param <M> Method type * @param <M> Method type
* @return the status code * @return the status code
* @throws IOException on any failure * @throws IOException on any failure

2
hadoop-tools/hadoop-openstack/src/main/java/org/apache/hadoop/fs/swift/package.html
View File

@ -64,7 +64,7 @@ <h2>Supporting multiple Swift Filesystems</h2>
the hostname of an S3 container is two-level, the name of the service provider the hostname of an S3 container is two-level, the name of the service provider
being the second path: <code>swift://bucket.service/</code> being the second path: <code>swift://bucket.service/</code>
The <code>service</code> portion of this domainame is used as a reference into The <code>service</code> portion of this domain name is used as a reference into
the client settings -and so identify the service provider of that container. the client settings -and so identify the service provider of that container.

4
hadoop-tools/hadoop-openstack/src/main/java/org/apache/hadoop/fs/swift/snative/SwiftNativeFileSystem.java
View File

@ -301,7 +301,7 @@ public BlockLocation[] getFileBlockLocations(FileStatus file,
* creating directories until one that exists is found. * creating directories until one that exists is found.
* *
* This strategy means if a file is created in an existing directory, * This strategy means if a file is created in an existing directory,
* one quick poll sufficies. * one quick poll suffices.
* *
* There is a big assumption here: that all parent directories of an existing * There is a big assumption here: that all parent directories of an existing
* directory also exists. * directory also exists.
@ -540,7 +540,7 @@ public FSDataInputStream open(Path path, int bufferSize) throws IOException {
* Low-level operation to also set the block size for this operation * Low-level operation to also set the block size for this operation
* @param path the file name to open * @param path the file name to open
* @param bufferSize the size of the buffer to be used. * @param bufferSize the size of the buffer to be used.
* @param readBlockSize how big should the read blockk/buffer size be? * @param readBlockSize how big should the read block/buffer size be?
* @return the input stream * @return the input stream
* @throws FileNotFoundException if the file is not found * @throws FileNotFoundException if the file is not found
* @throws IOException any IO problem * @throws IOException any IO problem

4
hadoop-tools/hadoop-openstack/src/main/java/org/apache/hadoop/fs/swift/snative/SwiftNativeFileSystemStore.java
View File

@ -590,7 +590,7 @@ public void rename(Path src, Path dst)
//outcome #2 -move to subdir of dest //outcome #2 -move to subdir of dest
destPath = toObjectPath(new Path(dst, src.getName())); destPath = toObjectPath(new Path(dst, src.getName()));
} else { } else {
//outcome #1 dest it's a file: fail if differeent //outcome #1 dest it's a file: fail if different
if (!renamingOnToSelf) { if (!renamingOnToSelf) {
throw new FileAlreadyExistsException( throw new FileAlreadyExistsException(
"cannot rename a file over one that already exists"); "cannot rename a file over one that already exists");
@ -953,7 +953,7 @@ public boolean delete(Path absolutePath, boolean recursive) throws IOException {
statuses, "; ")); statuses, "; "));
} }
//delete the entries. including ourself. //delete the entries. including ourselves.
for (FileStatus entryStatus : statuses) { for (FileStatus entryStatus : statuses) {
Path entryPath = entryStatus.getPath(); Path entryPath = entryStatus.getPath();
try { try {

2
hadoop-tools/hadoop-openstack/src/main/java/org/apache/hadoop/fs/swift/snative/SwiftNativeOutputStream.java
View File

@ -261,7 +261,7 @@ private void writeToBackupStream(byte[] buffer, int offset, int len) throws
assert len >= 0 : "remainder to write is negative"; assert len >= 0 : "remainder to write is negative";
SwiftUtils.debug(LOG," writeToBackupStream(offset=%d, len=%d)", offset, len); SwiftUtils.debug(LOG," writeToBackupStream(offset=%d, len=%d)", offset, len);
if (len == 0) { if (len == 0) {
//no remainder -downgrade to noop //no remainder -downgrade to no-op
return; return;
} }

2
hadoop-tools/hadoop-openstack/src/main/java/org/apache/hadoop/fs/swift/util/DurationStats.java
View File

@ -40,7 +40,7 @@ public DurationStats(String operation) {
} }
/** /**
* construct from anothr stats entry; * construct from another stats entry;
* all value are copied. * all value are copied.
* @param that the source statistics * @param that the source statistics
*/ */

6
hadoop-tools/hadoop-openstack/src/main/java/org/apache/hadoop/fs/swift/util/SwiftTestUtils.java
View File

@ -165,7 +165,7 @@ public static void writeDataset(FileSystem fs,
} }
/** /**
* Read the file and convert to a byte dataaset * Read the file and convert to a byte dataset
* @param fs filesystem * @param fs filesystem
* @param path path to read from * @param path path to read from
* @param len length of data to read * @param len length of data to read
@ -185,7 +185,7 @@ public static byte[] readDataset(FileSystem fs, Path path, int len)
} }
/** /**
* Assert that tthe array src[0..len] and dest[] are equal * Assert that the array src[0..len] and dest[] are equal
* @param src source data * @param src source data
* @param dest actual * @param dest actual
* @param len length of bytes to compare * @param len length of bytes to compare
@ -522,7 +522,7 @@ public static void assertPathDoesNotExist(FileSystem fileSystem,
* @param fs filesystem * @param fs filesystem
* @param dir directory to scan * @param dir directory to scan
* @param subdir full path to look for * @param subdir full path to look for
* @throws IOException IO probles * @throws IOException IO problems
*/ */
public static void assertListStatusFinds(FileSystem fs, public static void assertListStatusFinds(FileSystem fs,
Path dir, Path dir,

8
hadoop-tools/hadoop-openstack/src/main/java/org/apache/hadoop/fs/swift/util/SwiftUtils.java
View File

@ -82,7 +82,7 @@ public static boolean isFilePretendingToBeDirectory(FileStatus fileStatus) {
} }
/** /**
* Predicate: Is a swift object referring to the root direcory? * Predicate: Is a swift object referring to the root directory?
* @param swiftObject object to probe * @param swiftObject object to probe
* @return true iff the object refers to the root * @return true iff the object refers to the root
*/ */
@ -147,7 +147,7 @@ public static String partitionFilenameFromNumber(int partNumber) {
* @param fileSystem filesystem * @param fileSystem filesystem
* @param path directory * @param path directory
* @return a listing of the filestatuses of elements in the directory, one * @return a listing of the filestatuses of elements in the directory, one
* to a line, precedeed by the full path of the directory * to a line, preceded by the full path of the directory
* @throws IOException connectivity problems * @throws IOException connectivity problems
*/ */
public static String ls(FileSystem fileSystem, Path path) throws public static String ls(FileSystem fileSystem, Path path) throws
@ -169,7 +169,7 @@ public static String ls(FileSystem fileSystem, Path path) throws
} }
/** /**
* Take an array of filestats and convert to a string (prefixed w/ a [01] counter * Take an array of filestatus and convert to a string (prefixed w/ a [01] counter
* @param stats array of stats * @param stats array of stats
* @param separator separator after every entry * @param separator separator after every entry
* @return a stringified set * @return a stringified set
@ -184,7 +184,7 @@ public static String fileStatsToString(FileStatus[] stats, String separator) {
/** /**
* Verify that the basic args to a read operation are valid; * Verify that the basic args to a read operation are valid;
* throws an exception if not -with meaningful text includeing * throws an exception if not -with meaningful text including
* @param buffer destination buffer * @param buffer destination buffer
* @param off offset * @param off offset
* @param len number of bytes to read * @param len number of bytes to read

2
hadoop-tools/hadoop-openstack/src/test/java/org/apache/hadoop/fs/swift/SwiftFileSystemBaseTest.java
View File

@ -233,7 +233,7 @@ protected void rename(Path src, Path dst, boolean renameMustSucceed,
/** /**
* Get a string describing the outcome of a rename, by listing the dest * Get a string describing the outcome of a rename, by listing the dest
* path and its parent along with some covering text * path and its parent along with some covering text
* @param src source patj * @param src source path
* @param dst dest path * @param dst dest path
* @return a string for logs and exceptions * @return a string for logs and exceptions
* @throws IOException IO problems * @throws IOException IO problems

2
hadoop-tools/hadoop-openstack/src/test/java/org/apache/hadoop/fs/swift/TestSwiftFileSystemDirectories.java
View File

@ -28,7 +28,7 @@
/** /**
* Test swift-specific directory logic. * Test swift-specific directory logic.
* This class is HDFS-1 compatible; its designed to be subclases by something * This class is HDFS-1 compatible; its designed to be subclasses by something
* with HDFS2 extensions * with HDFS2 extensions
*/ */
public class TestSwiftFileSystemDirectories extends SwiftFileSystemBaseTest { public class TestSwiftFileSystemDirectories extends SwiftFileSystemBaseTest {

2
hadoop-tools/hadoop-openstack/src/test/java/org/apache/hadoop/fs/swift/TestSwiftFileSystemExtendedContract.java
View File

@ -131,7 +131,7 @@ public void testFilesystemIsCaseSensitive() throws Exception {
out.writeUTF("l"); out.writeUTF("l");
out.close(); out.close();
assertExists("lower case file", lower); assertExists("lower case file", lower);
//verifEy the length of the upper file hasn't changed //verify the length of the upper file hasn't changed
assertExists("Original upper case file " + upper, upper); assertExists("Original upper case file " + upper, upper);
FileStatus newStatus = fs.getFileStatus(upper); FileStatus newStatus = fs.getFileStatus(upper);
assertEquals("Expected status:" + upperStatus assertEquals("Expected status:" + upperStatus