Skip to content

Commit a5e418d

Browse files
jean-philippe-martinjean-philippe-martin
committed
cosmetic changes
1 parent 0c1c208 commit a5e418d

File tree

6 files changed

+73
-34
lines changed

6 files changed

+73
-34
lines changed

‎google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageConfiguration.java‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ public static final class Builder {
9191
* {@link CloudStorageFileSystem} object.
9292
*
9393
* @throws IllegalArgumentException if {@code path} is not absolute.
94+
* @param path the new current working directory
9495
* @return builder
9596
*/
9697
public Builder workingDirectory(String path) {
@@ -103,6 +104,7 @@ public Builder workingDirectory(String path) {
103104
* Configures whether or not we should throw an exception when encountering object names
104105
* containing superfluous slashes, e.g. {@code a//b}.
105106
*
107+
* @param value whether to permit empty path components (will throw if false)
106108
* @return builder
107109
*/
108110
public Builder permitEmptyPathComponents(boolean value) {
@@ -116,7 +118,7 @@ public Builder permitEmptyPathComponents(boolean value) {
116118
* <p>If you disable this feature, please take into consideration that all paths created from a
117119
* URI will have the leading slash.
118120
*
119-
* @parm value if true, remove the '/' prefix on absolute object names
121+
* @param value if true, remove the '/' prefix on absolute object names
120122
* @return builder
121123
*/
122124
public Builder stripPrefixSlash(boolean value) {
@@ -127,7 +129,7 @@ public Builder stripPrefixSlash(boolean value) {
127129
/**
128130
* Configures if paths with a trailing slash should be treated as fake directories.
129131
*
130-
* @parm value whether paths with a trailing slash should be treated as fake directories.
132+
* @param value whether paths with a trailing slash should be treated as fake directories.
131133
* @return builder
132134
*/
133135
public Builder usePseudoDirectories(boolean value) {
@@ -140,7 +142,7 @@ public Builder usePseudoDirectories(boolean value) {
140142
*
141143
* <p>The default is {@value CloudStorageFileSystem#BLOCK_SIZE_DEFAULT}.
142144
*
143-
* @parm value block size in bytes that should be used for each HTTP request to the API.
145+
* @param value block size in bytes that should be used for each HTTP request to the API.
144146
* @return builder
145147
*/
146148
public Builder blockSize(int value) {

‎google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageFileAttributes.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,49 +29,49 @@
2929
public interface CloudStorageFileAttributes extends BasicFileAttributes {
3030

3131
/**
32-
* Returns HTTP etag hash of object contents.
32+
* @return HTTP etag hash of object contents.
3333
*
3434
* @see "https://developers.google.com/storage/docs/hashes-etags"
3535
*/
3636
Optional<String> etag();
3737

3838
/**
39-
* Returns mime type (e.g. text/plain), if set.
39+
* @return mime type (e.g. text/plain), if set.
4040
*
4141
* @see "http://en.wikipedia.org/wiki/Internet_media_type#List_of_common_media_types"
4242
*/
4343
Optional<String> mimeType();
4444

4545
/**
46-
* Returns access control list.
46+
* @return access control list.
4747
*
4848
* @see "https://developers.google.com/storage/docs/reference-headers#acl"
4949
*/
5050
Optional<List<Acl>> acl();
5151

5252
/**
53-
* Returns {@code Cache-Control} HTTP header value, if set.
53+
* @return {@code Cache-Control} HTTP header value, if set.
5454
*
5555
* @see "https://developers.google.com/storage/docs/reference-headers#cachecontrol"
5656
*/
5757
Optional<String> cacheControl();
5858

5959
/**
60-
* Returns {@code Content-Encoding} HTTP header value, if set.
60+
* @return {@code Content-Encoding} HTTP header value, if set.
6161
*
6262
* @see "https://developers.google.com/storage/docs/reference-headers#contentencoding"
6363
*/
6464
Optional<String> contentEncoding();
6565

6666
/**
67-
* Returns {@code Content-Disposition} HTTP header value, if set.
67+
* @return {@code Content-Disposition} HTTP header value, if set.
6868
*
6969
* @see "https://developers.google.com/storage/docs/reference-headers#contentdisposition"
7070
*/
7171
Optional<String> contentDisposition();
7272

7373
/**
74-
* Returns user-specified metadata.
74+
* @return user-specified metadata.
7575
*
7676
* @see "https://developers.google.com/storage/docs/reference-headers#contentdisposition"
7777
*/

‎google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageFileSystem.java‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,8 @@ public static CloudStorageFileSystem forBucket(String bucket) {
8484
/**
8585
* Creates new file system instance for {@code bucket}, with customizable settings.
8686
*
87+
* @param bucket the bucket to access
88+
* @param config configuration
8789
* @see #forBucket(String)
8890
*/
8991
@CheckReturnValue
@@ -107,6 +109,10 @@ public static CloudStorageFileSystem forBucket(String bucket, CloudStorageConfig
107109
* from using that if possible, for the reasons documented in
108110
* {@link CloudStorageFileSystemProvider#newFileSystem(URI, java.util.Map)}
109111
*
112+
* @param bucket the bucket to access
113+
* @param config configuration
114+
* @param storageOptions storage options
115+
*
110116
* @see java.nio.file.FileSystems#getFileSystem(URI)
111117
*/
112118
@CheckReturnValue
@@ -132,21 +138,24 @@ public CloudStorageFileSystemProvider provider() {
132138
}
133139

134140
/**
135-
* Returns Cloud Storage bucket name being served by this file system.
141+
* @return Cloud Storage bucket name being served by this file system.
136142
*/
137143
public String bucket() {
138144
return bucket;
139145
}
140146

141147
/**
142-
* Returns configuration object for this file system instance.
148+
* @return configuration object for this file system instance.
143149
*/
144150
public CloudStorageConfiguration config() {
145151
return config;
146152
}
147153

148154
/**
149155
* Converts Cloud Storage object name to a {@link Path} object.
156+
*
157+
* @param first cloud storage object name
158+
* @return Path object
150159
*/
151160
@Override
152161
public CloudStoragePath getPath(String first, String... more) {
@@ -168,23 +177,23 @@ public void close() throws IOException {
168177
}
169178

170179
/**
171-
* Returns {@code true}, even if you previously called the {@link #close()} method.
180+
* @return {@code true}, even if you previously called the {@link #close()} method.
172181
*/
173182
@Override
174183
public boolean isOpen() {
175184
return true;
176185
}
177186

178187
/**
179-
* Returns {@code false}.
188+
* @return {@code false}.
180189
*/
181190
@Override
182191
public boolean isReadOnly() {
183192
return false;
184193
}
185194

186195
/**
187-
* Returns {@value UnixPath#SEPARATOR}.
196+
* @return {@value UnixPath#SEPARATOR}.
188197
*/
189198
@Override
190199
public String getSeparator() {

‎google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageFileSystemProvider.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ protected Path computeNext() {
121121

122122
/**
123123
* Sets options that are only used by the constructor.
124+
*
125+
* @param newStorageOptions options that are only used by the constructor
124126
*/
125127
@VisibleForTesting
126128
public static void setStorageOptions(StorageOptions newStorageOptions) {
@@ -170,7 +172,7 @@ public CloudStorageFileSystem getFileSystem(URI uri) {
170172
}
171173

172174
/**
173-
* Returns Cloud Storage file system, provided a URI with no path, e.g. {@code gs://bucket}.
175+
* @return Cloud Storage file system, provided a URI with no path, e.g. {@code gs://bucket}.
174176
*
175177
* @param uri bucket and current working directory, e.g. {@code gs://bucket}
176178
* @param env map of configuration options, whose keys correspond to the method names of

‎google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageOptions.java‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,17 @@ public final class CloudStorageOptions {
2525

2626
/**
2727
* Sets the mime type header on an object, e.g. {@code "text/plain"}.
28+
*
29+
* @param mimeType MIME type
30+
* @return the corresponding option
2831
*/
2932
public static CloudStorageOption.OpenCopy withMimeType(String mimeType) {
3033
return OptionMimeType.create(mimeType);
3134
}
3235

3336
/**
3437
* Disables caching on an object. Same as: {@code withCacheControl("no-cache")}.
38+
* @return the corresponding option
3539
*/
3640
public static CloudStorageOption.OpenCopy withoutCaching() {
3741
return withCacheControl("no-cache");
@@ -41,6 +45,9 @@ public static CloudStorageOption.OpenCopy withoutCaching() {
4145
* Sets the {@code Cache-Control} HTTP header on an object.
4246
*
4347
* @see "https://developers.google.com/storage/docs/reference-headers#cachecontrol"
48+
*
49+
* @param cacheControl Cache-Control HTTP header
50+
* @return the corresponding option
4451
*/
4552
public static CloudStorageOption.OpenCopy withCacheControl(String cacheControl) {
4653
return OptionCacheControl.create(cacheControl);
@@ -50,6 +57,9 @@ public static CloudStorageOption.OpenCopy withCacheControl(String cacheControl)
5057
* Sets the {@code Content-Disposition} HTTP header on an object.
5158
*
5259
* @see "https://developers.google.com/storage/docs/reference-headers#contentdisposition"
60+
*
61+
* @param contentDisposition Content-Disposition HTTP header
62+
* @return the corresponding option
5363
*/
5464
public static CloudStorageOption.OpenCopy withContentDisposition(String contentDisposition) {
5565
return OptionContentDisposition.create(contentDisposition);
@@ -59,6 +69,9 @@ public static CloudStorageOption.OpenCopy withContentDisposition(String contentD
5969
* Sets the {@code Content-Encoding} HTTP header on an object.
6070
*
6171
* @see "https://developers.google.com/storage/docs/reference-headers#contentencoding"
72+
*
73+
* @param contentEncoding content encoding
74+
* @return the corresponding option
6275
*/
6376
public static CloudStorageOption.OpenCopy withContentEncoding(String contentEncoding) {
6477
return OptionContentEncoding.create(contentEncoding);
@@ -68,6 +81,9 @@ public static CloudStorageOption.OpenCopy withContentEncoding(String contentEnco
6881
* Sets the ACL value on a Cloud Storage object.
6982
*
7083
* @see "https://developers.google.com/storage/docs/reference-headers#acl"
84+
*
85+
* @param acl ACL value
86+
* @return the corresponding option
7187
*/
7288
public static CloudStorageOption.OpenCopy withAcl(Acl acl) {
7389
return OptionAcl.create(acl);
@@ -77,6 +93,10 @@ public static CloudStorageOption.OpenCopy withAcl(Acl acl) {
7793
* Sets an unmodifiable piece of user metadata on a Cloud Storage object.
7894
*
7995
* @see "https://developers.google.com/storage/docs/reference-headers#xgoogmeta"
96+
*
97+
* @param key metadata key
98+
* @param value metadata value
99+
* @return the corresponding option
80100
*/
81101
public static CloudStorageOption.OpenCopy withUserMetadata(String key, String value) {
82102
return OptionUserMetadata.create(key, value);
@@ -86,6 +106,9 @@ public static CloudStorageOption.OpenCopy withUserMetadata(String key, String va
86106
* Sets the block size (in bytes) when talking to the Google Cloud Storage server.
87107
*
88108
* <p>The default is {@value CloudStorageFileSystem#BLOCK_SIZE_DEFAULT}.
109+
*
110+
* @param size block size (in bytes)
111+
* @return the corresponding option
89112
*/
90113
public static CloudStorageOption.OpenCopy withBlockSize(int size) {
91114
return OptionBlockSize.create(size);

‎google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/SeekableByteChannelPrefetcher.java‎

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
* (Of course this is only worthwhile if the underlying SeekableByteChannel doesn't already
4545
* implement prefetching).
4646
*
47-
* The prefetcher can read with multiple threads in parallel, and it can keep a buffered
47+
* <p> The prefetcher can read with multiple threads in parallel, and it can keep a buffered
4848
* copy of already-read bytes just in case the caller doesn't follow a strictly linear pattern.
4949
* It can also optionally use an extra thread in case of out-of-order reads to fetch the data at
5050
* once even if all prefetching threads are busy.
@@ -68,7 +68,7 @@ public class SeekableByteChannelPrefetcher implements SeekableByteChannel {
6868
private long position;
6969
// whether we're open.
7070
private boolean open = true;
71-
private boolean closing = false;
71+
private boolean closing;
7272

7373
private final ExecutorService exec;
7474
private final Sorted buffers;
@@ -120,7 +120,7 @@ public int size() {
120120
}
121121

122122
private class Worker implements Callable<ByteBuffer>, Closeable {
123-
ByteBuffer bb = null;
123+
ByteBuffer bb;
124124
long pos;
125125
SeekableByteChannel chan;
126126

@@ -146,8 +146,9 @@ public ByteBuffer call() throws IOException, ExecutionException, InterruptedExce
146146
}
147147
chan.position(pos);
148148
ByteBuffer b = this.bb;
149-
// read until buffer is full, or EOF
150-
while (chan.read(b) > 0 && !closing) {}
149+
while (chan.read(b) > 0 && !closing) {
150+
// read until buffer is full, or EOF
151+
}
151152
reassignWorker(this);
152153
return b;
153154
}
@@ -179,7 +180,7 @@ public SeekableByteChannelPrefetcher(SeekableByteChannelPrefetcherOptions opts,
179180
/**
180181
* Reads a sequence of bytes from this channel into the given buffer.
181182
*
182-
* @param dst
183+
* @param dst destination buffer
183184
*/
184185
@Override
185186
public int read(ByteBuffer dst) throws IOException {
@@ -244,18 +245,18 @@ public long position() throws IOException {
244245

245246
/**
246247
* Sets this channel's position.
247-
* <p>
248+
*
248249
* <p> Setting the position to a value that is greater than the current size
249250
* is legal but does not change the size of the entity. A later attempt to
250251
* read bytes at such a position will immediately return an end-of-file
251252
* indication. A later attempt to write bytes at such a position will cause
252253
* the entity to grow to accommodate the new bytes; the values of any bytes
253254
* between the previous end-of-file and the newly-written bytes are
254255
* unspecified.
255-
* <p>
256+
*
256257
* <p> Setting the channel's position is not recommended when connected to
257-
* an entity, typically a file, that is opened with the {@link
258-
* StandardOpenOption#APPEND APPEND} option. When opened for
258+
* an entity, typically a file, that is opened with the
259+
* StandardOpenOption.APPEND option. When opened for
259260
* append, the position is first advanced to the end before writing.
260261
*
261262
* @param newPosition The new position, a non-negative integer counting
@@ -309,14 +310,14 @@ public boolean isOpen() {
309310

310311
/**
311312
* Closes this channel.
312-
* <p>
313+
*
313314
* <p> After a channel is closed, any further attempt to invoke I/O
314315
* operations upon it will cause a {@link ClosedChannelException} to be
315316
* thrown.
316-
* <p>
317+
*
317318
* <p> If this channel is already closed then invoking this method has no
318319
* effect.
319-
* <p>
320+
*
320321
* <p> This method may be invoked at any time. If some other thread has
321322
* already invoked it, however, then another invocation will block until
322323
* the first invocation is complete, after which it will return without
@@ -330,12 +331,14 @@ public void close() throws IOException {
330331
closing = true;
331332
exec.shutdown();
332333
try {
333-
while (true) synchronized (idleWorkers) {
334-
if (idleWorkers.size() >= workerCount) {
335-
// every thread is idle, we're done.
336-
break;
334+
while (true) {
335+
synchronized (idleWorkers) {
336+
if (idleWorkers.size() >= workerCount) {
337+
// every thread is idle, we're done.
338+
break;
339+
}
340+
idleWorkers.wait(60_000);
337341
}
338-
idleWorkers.wait(60_000);
339342
}
340343
} catch (InterruptedException e) {
341344
System.out.println("Timed out while waiting for channels to close.");

0 commit comments

Comments
 (0)