RFR: 8215788: Clarify JarInputStream Manifest access [v8]

[Lance Andersen]

On Mon, 19 Sep 2022 19:26:53 GMT, Sean Mullan <mullan at openjdk.org> wrote:

>> Lance Andersen has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   Minor clarification for verifying an JarInputStream
>
> src/java.base/share/classes/java/util/jar/JarInputStream.java line 44:
> 
>> 42:  * <p>
>> 43:  * The {@link #getManifest() getManifest} method is used to return the
>> 44:  * <a href="{@docRoot}/../specs/jar/jar.html#jar-manifest">JAR Manifest</a>
> 
> Is it necessary to put "JAR" before "Manifest"? In the previous paragraph, you did not.

Removed JAR

> src/java.base/share/classes/java/util/jar/JarInputStream.java line 46:
> 
>> 44:  * <a href="{@docRoot}/../specs/jar/jar.html#jar-manifest">JAR Manifest</a>
>> 45:  * from the entry {@code META-INF/MANIFEST.MF} when it is the first entry
>> 46:  * in the stream (or the second entry the first entry in the stream is
> 
> missing "if": "or the second entry if ..."

updated

> src/java.base/share/classes/java/util/jar/JarInputStream.java line 47:
> 
>> 45:  * from the entry {@code META-INF/MANIFEST.MF} when it is the first entry
>> 46:  * in the stream (or the second entry the first entry in the stream is
>> 47:  * {@code META-INF/} and the second entry {@code META-INF/MANIFEST.MF}).
> 
> Missing "is": "and the second entry is ..."

updated

> src/java.base/share/classes/java/util/jar/JarInputStream.java line 48:
> 
>> 46:  * in the stream (or the second entry the first entry in the stream is
>> 47:  * {@code META-INF/} and the second entry {@code META-INF/MANIFEST.MF}).
>> 48:  *</p>
> 
> Nit, add space after "*".

fixed

> src/java.base/share/classes/java/util/jar/JarInputStream.java line 59:
> 
>> 57:  * </p>
>> 58:  *
>> 59:  *  <h2>Verifying a JarInputStream</h2>
> 
> Is there a reason this is indented one extra space?

Updated

> src/java.base/share/classes/java/util/jar/JarInputStream.java line 149:
> 
>> 147:     /**
>> 148:      * Returns the {@code Manifest} for this JAR file when it is the first entry
>> 149:      * in the stream (or the second entry the first entry in the stream is
> 
> missing "if": "or the second entry if ..."

updated

> src/java.base/share/classes/java/util/jar/JarInputStream.java line 150:
> 
>> 148:      * Returns the {@code Manifest} for this JAR file when it is the first entry
>> 149:      * in the stream (or the second entry the first entry in the stream is
>> 150:      * {@code META-INF/} and the second entry {@code META-INF/MANIFEST.MF}), or
> 
> Missing "is": "and the second entry is ..."

fixed

-------------

PR: https://git.openjdk.org/jdk/pull/10045