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

[Prasanta Sadhukhan-2]

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.

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

Commit messages:
 - 8263768: JFormattedTextField.AbstractFormatter.getDocumentFilter()/getNavigationFilter() spec doesn't mention what the default impls return and what does it mean

Changes: https://git.openjdk.java.net/jdk/pull/3064/files
 Webrev: https://webrevs.openjdk.java.net/?repo=jdk&pr=3064&range=00
  Issue: https://bugs.openjdk.java.net/browse/JDK-8263768
  Stats: 4 lines in 1 file changed: 2 ins; 0 del; 2 mod
  Patch: https://git.openjdk.java.net/jdk/pull/3064.diff
  Fetch: git fetch https://git.openjdk.java.net/jdk pull/3064/head:pull/3064

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

[Tejpal Rebari-2]

On Thu, 18 Mar 2021 04:46:03 GMT, Prasanta Sadhukhan <[hidden email]> 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.

Marked as reviewed by trebari (Committer).

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

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

[Alexey Ivanov-2]

On Thu, 18 Mar 2021 04:46:03 GMT, Prasanta Sadhukhan <[hidden email]> 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

[Prasanta Sadhukhan-2]

> 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.

Prasanta Sadhukhan has updated the pull request incrementally with one additional commit since the last revision:

  @implNote change

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

Changes:
  - all: https://git.openjdk.java.net/jdk/pull/3064/files
  - new: https://git.openjdk.java.net/jdk/pull/3064/files/e2b547b2..4ffa0d08

Webrevs:
 - full: https://webrevs.openjdk.java.net/?repo=jdk&pr=3064&range=01
 - incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=3064&range=00-01

  Stats: 6 lines in 1 file changed: 4 ins; 2 del; 0 mod
  Patch: https://git.openjdk.java.net/jdk/pull/3064.diff
  Fetch: git fetch https://git.openjdk.java.net/jdk pull/3064/head:pull/3064

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

[Alexey Ivanov-2]

On Fri, 19 Mar 2021 08:59:12 GMT, Prasanta Sadhukhan <[hidden email]> 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.
>
> Prasanta Sadhukhan has updated the pull request incrementally with one additional commit since the last revision:
>
>   @implNote change

Changes requested by aivanov (Reviewer).

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

> 1087:
> 1088:         /**
> 1089:          * Subclass must override if you wish to provide a

It think the original text was correct: Subclass was used as a verb in imperative. You have to *subclass* before you can override.

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

> 1106:          * the <code>JFormattedTextField</code>.
> 1107:          *
> 1108:          * @implNote The default implementation returns <code>null</code>

Suggestion:

         * @implNote The default implementation returns <code>null</code>.
Full stop for consistency.

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

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

[Prasanta Sadhukhan-2]

> 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.

Prasanta Sadhukhan has updated the pull request incrementally with one additional commit since the last revision:

  @implNote added

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

Changes:
  - all: https://git.openjdk.java.net/jdk/pull/3064/files
  - new: https://git.openjdk.java.net/jdk/pull/3064/files/4ffa0d08..cea2f171

Webrevs:
 - full: https://webrevs.openjdk.java.net/?repo=jdk&pr=3064&range=02
 - incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=3064&range=01-02

  Stats: 3 lines in 1 file changed: 0 ins; 0 del; 3 mod
  Patch: https://git.openjdk.java.net/jdk/pull/3064.diff
  Fetch: git fetch https://git.openjdk.java.net/jdk pull/3064/head:pull/3064

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

[Alexey Ivanov-2]

On Fri, 19 Mar 2021 11:15:03 GMT, Prasanta Sadhukhan <[hidden email]> 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.
>
> Prasanta Sadhukhan has updated the pull request incrementally with one additional commit since the last revision:
>
>   @implNote added

Marked as reviewed by aivanov (Reviewer).

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

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

[Alexander Zvegintsev-2]

On Fri, 19 Mar 2021 11:15:03 GMT, Prasanta Sadhukhan <[hidden email]> 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.
>
> Prasanta Sadhukhan has updated the pull request incrementally with one additional commit since the last revision:
>
>   @implNote added

The bug's title is `JFormattedTextField.AbstractFormatter.getDocumentFilter()/getNavigationFilter() spec doesn't mention what the default impls return and what does it mean`
The fix mentions what default implementation returns, but it looks like `what does it mean` is still not addressed.

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

Marked as reviewed by azvegint (Reviewer).

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

[Sergey Bylokhov-2]

On Fri, 19 Mar 2021 19:50:20 GMT, Alexander Zvegintsev <[hidden email]> wrote:

>> Prasanta Sadhukhan has updated the pull request incrementally with one additional commit since the last revision:
>>
>>   @implNote added
>
> The bug's title is `JFormattedTextField.AbstractFormatter.getDocumentFilter()/getNavigationFilter() spec doesn't mention what the default impls return and what does it mean`
> The fix mentions what default implementation returns, but it looks like `what does it mean` is still not addressed.

csr?

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

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

[Prasanta Sadhukhan-2]

On Fri, 19 Mar 2021 22:40:38 GMT, Sergey Bylokhov <[hidden email]> wrote:

>> The bug's title is `JFormattedTextField.AbstractFormatter.getDocumentFilter()/getNavigationFilter() spec doesn't mention what the default impls return and what does it mean`
>> The fix mentions what default implementation returns, but it looks like `what does it mean` is still not addressed.
>
> csr?

Added CSR https://bugs.openjdk.java.net/browse/JDK-8263922...Please review..

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

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

[Prasanta Sadhukhan-2]

> 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.

Prasanta Sadhukhan has updated the pull request incrementally with one additional commit since the last revision:

  Add @implSpec as per JoeDarcy's recommendation

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

Changes:
  - all: https://git.openjdk.java.net/jdk/pull/3064/files
  - new: https://git.openjdk.java.net/jdk/pull/3064/files/cea2f171..0fdd15f4

Webrevs:
 - full: https://webrevs.openjdk.java.net/?repo=jdk&pr=3064&range=03
 - incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=3064&range=02-03

  Stats: 2 lines in 1 file changed: 0 ins; 0 del; 2 mod
  Patch: https://git.openjdk.java.net/jdk/pull/3064.diff
  Fetch: git fetch https://git.openjdk.java.net/jdk pull/3064/head:pull/3064

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

[Alexey Ivanov-2]

On Wed, 24 Mar 2021 04:32:01 GMT, Prasanta Sadhukhan <[hidden email]> 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.
>
> Prasanta Sadhukhan has updated the pull request incrementally with one additional commit since the last revision:
>
>   Add @implSpec as per JoeDarcy's recommendation

Marked as reviewed by aivanov (Reviewer).

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

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

[Alexey Ivanov-2]

On Wed, 24 Mar 2021 20:01:25 GMT, Alexey Ivanov <[hidden email]> wrote:

>> Prasanta Sadhukhan has updated the pull request incrementally with one additional commit since the last revision:
>>
>>   Add @implSpec as per JoeDarcy's recommendation
>
> Marked as reviewed by aivanov (Reviewer).

> csr?

For my own clarification, does any change to the javadoc require a CSR?

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

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

[Sergey Bylokhov-2]

On Wed, 24 Mar 2021 20:07:48 GMT, Alexey Ivanov <[hidden email]> wrote:

> For my own clarification, does any change to the javadoc require a CSR?

Any changes which add the new testable statements. Actually most change except typos/renames/format.

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

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

[Alexey Ivanov-2]

On Wed, 24 Mar 2021 20:10:04 GMT, Sergey Bylokhov <[hidden email]> wrote:

> > For my own clarification, does any change to the javadoc require a CSR?
>
> Any changes which add the new testable statements. Actually most change except typos/renames/format.

Thank you.

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

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

[Joe Darcy-2]

On Wed, 24 Mar 2021 04:32:01 GMT, Prasanta Sadhukhan <[hidden email]> 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.
>
> Prasanta Sadhukhan has updated the pull request incrementally with one additional commit since the last revision:
>
>   Add @implSpec as per JoeDarcy's recommendation

Marked as reviewed by darcy (Reviewer).

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

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

[Prasanta Sadhukhan-2]

On Thu, 18 Mar 2021 04:46:03 GMT, Prasanta Sadhukhan <[hidden email]> 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.

This pull request has now been integrated.

Changeset: 3fcb499c
Author:    Prasanta Sadhukhan <[hidden email]>
URL:       https://git.openjdk.java.net/jdk/commit/3fcb499c
Stats:     4 lines in 1 file changed: 4 ins; 0 del; 0 mod

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

Reviewed-by: trebari, aivanov, azvegint, darcy

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

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