<Swing Dev> RFR: 8263768: JFormattedTextField.AbstractFormatter.getDocumentFilter()/getNavigationFilter() spec doesn't mention what the default impls return and what does it mean

[Alexey Ivanov]

On Thu, 18 Mar 2021 04:46:03 GMT, Prasanta Sadhukhan <psadhukhan at openjdk.org> wrote:

> Default implementation of JFormattedTextField.AbstractFormatter.getDocumentFilter()/getNavigationFilter() returns null but it is not mentioned in the spec.
> It is now explicitly mentioned in the spec by @impNote tag.

Changes requested by aivanov (Reviewer).

src/java.desktop/share/classes/javax/swing/JFormattedTextField.java line 1089:

> 1087: 
> 1088:         /**
> 1089:          * @implNote Default implementation returns null.

I suggest moving `@implNote` to the end of the spec, otherwise the entire spec is the implementation note, which is wrong, isn't it?

Suggestion:

         * @implNote The default implementation returns <code>null</code>.
It requires the definite article.

Both points above also apply to `getNavigationFilter` method below.

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

PR: https://git.openjdk.java.net/jdk/pull/3064