Kulla: Please review JShell API

[joe darcy]

Hi Robert,

On 7/6/2015 3:51 PM, Robert Field wrote:
> Thank you Joe.
>
> I’ve added this to the API docs bug JDK-8130637 
> <https://bugs.openjdk.java.net/browse/JDK-8130637>
>
> Why are fields not advised in KeyStatusEvent?  It is a struct with all 
> final fields.

Using fields is an overcommitment to a particular implementation. Having 
methods would provide a level of indirection if at some point in the 
future a direct field access was not wanted.

Thanks,

-Joe

>
> Thanks,
> Robert
>
>> On Jun 29, 2015, at 6:43 PM, Joseph D. Darcy <joe.darcy at oracle.com 
>> <mailto:joe.darcy at oracle.com>> wrote:
>>
>> Hi Robert,
>>
>> A few quick comments.
>>
>> The sources files in the API don't seem to have been compiled with 
>> the doclint as there seem to be missing javadoc on various methods, 
>> etc. Please run with
>>
>>     -Xlint:all -Xdoclint:all/protected
>>
>> and see what sort of warnings are produced. (Some of the exception 
>> types might also be missing serialVersionUID fields.)
>>
>> There doesn't seem to be a package-info.java file for the new package.
>>
>> Some of the types reference particular sections of "The Java Language 
>> Specification." In the JDK sources, we use the @jls tag for that 
>> purpose. There are example uses of the tag in the java.lang package.
>>
>> The use of fields rather than methods in KeyStatusEvent is not advised.
>>
>> HTH,
>>
>> -Joe
>