Skip to content

Commit 0802348

Browse files
committed
8358558: (zipfs) Reorder the listing of "accessMode" property in the ZIP file system's documentation
Reviewed-by: dfuchs, vyazici, alanb, lancea
1 parent 849655a commit 0802348

1 file changed

Lines changed: 41 additions & 42 deletions

File tree

src/jdk.zipfs/share/classes/module-info.java

Lines changed: 41 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -149,12 +149,52 @@
149149
*
150150
* <tbody>
151151
* <tr>
152+
* <th scope="row">accessMode</th>
153+
* <td>{@link java.lang.String}</td>
154+
* <td>null/unset</td>
155+
* <td>
156+
* A value defining the desired access mode of the file system.
157+
* ZIP file systems can be created to allow for <em>read-write</em> or
158+
* <em>read-only</em> access.
159+
* <ul>
160+
* <li>
161+
* If no value is set, the file system is created as <em>read-write</em>
162+
* if possible. Use {@link java.nio.file.FileSystem#isReadOnly()
163+
* isReadOnly()} to determine the actual access mode.
164+
* </li>
165+
* <li>
166+
* If the value is {@code "readOnly"}, the file system is created
167+
* <em>read-only</em>, and {@link java.nio.file.FileSystem#isReadOnly()
168+
* isReadOnly()} will always return {@code true}. Creating a
169+
* <em>read-only</em> file system requires the underlying ZIP file to
170+
* already exist.
171+
* </li>
172+
* <li>
173+
* If the value is {@code "readWrite"}, the file system is created
174+
* <em>read-write</em>, and {@link java.nio.file.FileSystem#isReadOnly()
175+
* isReadOnly()} will always return {@code false}. If a writable file
176+
* system cannot be created, an {@code IOException} will be thrown
177+
* when creating the ZIP file system.
178+
* </li>
179+
* <li>
180+
* Any other values will cause an {@code IllegalArgumentException}
181+
* to be thrown when creating the ZIP file system.
182+
* </li>
183+
* </ul>
184+
* The {@code accessMode} property has no effect on reported POSIX file
185+
* permissions (in cases where POSIX support is enabled).
186+
* </td>
187+
* </tr>
188+
* <tr>
152189
* <th scope="row">create</th>
153190
* <td>{@link java.lang.String} or {@link java.lang.Boolean}</td>
154191
* <td>false</td>
155192
* <td>
156193
* If the value is {@code true}, the ZIP file system provider creates a
157-
* new ZIP or JAR file if it does not exist.
194+
* new ZIP or JAR file if it does not exist. Specifying the {@code create}
195+
* property as {@code true} with the {@code accessMode} as {@code "readOnly"}
196+
* will cause an {@code IllegalArgumentException} to be thrown when creating
197+
* the ZIP file system.
158198
* </td>
159199
* </tr>
160200
* <tr>
@@ -266,47 +306,6 @@
266306
* </ul>
267307
* </td>
268308
* </tr>
269-
* <tr>
270-
* <th scope="row">accessMode</th>
271-
* <td>{@link java.lang.String}</td>
272-
* <td>null/unset</td>
273-
* <td>
274-
* A value defining the desired access mode of the file system.
275-
* ZIP file systems can be created to allow for <em>read-write</em> or
276-
* <em>read-only</em> access.
277-
* <ul>
278-
* <li>
279-
* If no value is set, the file system is created as <em>read-write</em>
280-
* if possible. Use {@link java.nio.file.FileSystem#isReadOnly()
281-
* isReadOnly()} to determine the actual access mode.
282-
* </li>
283-
* <li>
284-
* If the value is {@code "readOnly"}, the file system is created
285-
* <em>read-only</em>, and {@link java.nio.file.FileSystem#isReadOnly()
286-
* isReadOnly()} will always return {@code true}. Creating a
287-
* <em>read-only</em> file system requires the underlying ZIP file to
288-
* already exist.
289-
* Specifying the {@code create} property as {@code true} with the
290-
* {@code accessMode} as {@code readOnly} will cause an {@code
291-
* IllegalArgumentException} to be thrown when creating the ZIP file
292-
* system.
293-
* </li>
294-
* <li>
295-
* If the value is {@code "readWrite"}, the file system is created
296-
* <em>read-write</em>, and {@link java.nio.file.FileSystem#isReadOnly()
297-
* isReadOnly()} will always return {@code false}. If a writable file
298-
* system cannot be created, an {@code IOException} will be thrown
299-
* when creating the ZIP file system.
300-
* </li>
301-
* <li>
302-
* Any other values will cause an {@code IllegalArgumentException}
303-
* to be thrown when creating the ZIP file system.
304-
* </li>
305-
* </ul>
306-
* The {@code accessMode} property has no effect on reported POSIX file
307-
* permissions (in cases where POSIX support is enabled).
308-
* </td>
309-
* </tr>
310309
* </tbody>
311310
* </table>
312311
*

0 commit comments

Comments
 (0)