Java completion enhanced to support no insertion of method parameters by sid-srini · Pull Request #7747 · apache/netbeans

sid-srini · 2024-09-12T09:27:22Z

This configurable enhancement is based on end-user feedback received in oracle/javavscode#197

This seems to be a matter of personal preference
It is not a reflection on the correctness of the default functionality.

Added a user preference for insertion of method parameters in code completions.
- "completion-insert-text-parameters"
- default value = true
- Also available via:
  - ide/editor.lib2: EditorPreferencesKeys.COMPLETION_INSERT_TEXT_PARAMETERS
  - java/java.completion: Utilities.isCompletionInsertTextParameters()
Added disabling of the above preference from the LSP client via the client config key PREFIX + "java.completion.disable.insertMethodParameters"
- Updation occurs in TextDocumentServiceImpl.completion()
Added an extra arg insertTextParams in the following interface methods with the default value true:
- JavaCompletionTask.ItemFactory:
  - createExecutableItem
  - createThisOrSuperConstructorItem
- JavaCompletionTask.TypeCastableItemFactory:
  - createTypeCastableExecutableItem
Invoked the above methods in JavaCompletionTask with this parameter value set by Utilities.isCompletionInsertTextParameters().
Enhanced the implementations of the above methods in JavaCompletionCollector and JavaCompletionItem to insert text for method arguments when insertTextParams (or !memberRef).
- The cursor would be placed inside the parentheses if it is not a no-args method completion.
Added a follow-up LSP command to the completion item "editor.action.triggerParameterHints" for showing the signature help when not inserting text parameters.
- This is a necessary guide for the user.
- It would not be triggered without this addition, since the trigger character '(' is not typed by the user.
Unrelated minor fixes in JavaCompletionCollector.ItemFactoryImpl:
- Added the default prefix ("nbls") to the usages of the follow-up command "java.complete.abstract.methods".
- Without this, the command would not get launched by the client.
- Added to the builder in createExecutableItem(), the instantiated follow-up command "nbls.java.complete.abstract.methods".

lahodaj

I went through the patch - overall seems sensible. Added a few comments here and there. But, I think @dbalek should review - he might have some different views.

My probably biggest complaint would be that there are not tests checking the new behavior.

lahodaj · 2024-09-12T14:39:31Z

+     * Whether the code completion query search will be case-sensitive
     * Values: java.lang.Boolean
     */
    public static final String COMPLETION_CASE_SENSITIVE = "completion-case-sensitive"; // NOI18N


It might make sense to put the option name to the API, as is done for other options.

I didn't quite understand this suggestion. I refrained from adding to SimpleValueNames because the comment in EditorPreferenceKeys mentioned that the latter is meant for private keys, while the former for public, devel or friend keys.
I can move the key here if I misunderstood. Thanks.

I have removed the unrelated grammatical change in this file. Thanks.

sid-srini · 2024-09-12T14:55:57Z

I went through the patch - overall seems sensible. Added a few comments here and there. But, I think @dbalek should review - he might have some different views.

My probably biggest complaint would be that there are not tests checking the new behavior.

Thanks a lot @lahodaj.
I'll try to add some tests for the existing and new behaviour.

neilcsmith-net · 2024-09-12T15:19:43Z

Is there an IDE options UI for this?!

I'm curious at the reasoning for adding this where it is? It seems similar to the guess filled method arguments option? Between them they feel like they cover 3 states? (no fill, parameter names, guess values)

sid-srini · 2024-09-12T15:49:04Z

Is there an IDE options UI for this?!

Thanks @neilcsmith-net. I will try to add this.

Currently, this is implemented only for Java.
So, shall I add this only in the specific UI for Java within the Editor > Code Completions preferences?
Perhaps later when someone else needs this implemented for other languages, it could be exposed there.

I'm curious at the reasoning for adding this where it is? It seems similar to the guess filled method arguments option? Between them they feel like they cover 3 states? (no fill, parameter names, guess values)

Yes, that progression in the complexity for insertions makes sense to me.

boolean "completion-insert-text-parameters":
- on/off inserting parameter values
- inserted values maybe parameter names or guessed local variables or something else.
- possibly more widely available in different completion contexts
boolean "guessMethodArguments":
- on/off guessing a value from locally available variables
- inserted value takes effect only when the flag above is on.
- possibly unavailable in different completion contexts

Given that the latter is already a defined preference key, it seems easier to maintain backward compatibility and a minimal state increase with the added boolean flag.

When implementing the UI above, I could try to introduce joint states for these 2. However, it may become difficult to move the first setting to other languages.

Let me know if this analysis makes sense.

neilcsmith-net · 2024-09-12T16:40:31Z

Sure, I agree with keeping as two boolean flags. The UI could handle valid combinations / or just visually disable one checkbox if desired. I was just curious as to the different reasons / pros and cons of where the keys are registered. Obviously the guess arguments key is in the options panel UI code itself - https://github.com/apache/netbeans/blob/master/java/java.editor/src/org/netbeans/modules/java/editor/options/CodeCompletionPanel.java#L52 Let's let @dbalek review that.

… parameters 1. Added the config key "jdk.java.completion.disable.insertMethodParameters" to disable insertion of method arguments. 2. Added an *"in-review"* version of the NB patch PR apache/netbeans#7747 which implements this enhancement in the NBLS. Signed-off-by: Siddharth Srinivasan <siddharth.srinivasan@oracle.com>

sid-srini · 2025-08-21T21:20:01Z

I've rebased the PR to the current master and resolved the merge conflicts.

Let's let @dbalek review that.

Requesting reviews from @dbalek.
cc: @lahodaj @neilcsmith-net

Thank you

dbalek

Looks fine to me. However, as already mentioned by @lahodaj, some tests should be added.

lahodaj · 2025-09-08T06:29:25Z

@sid-srini
Please note you need to fix the sigtest, and squash. To fix the sigtest:

cd java/java.completion
ant gen-sigtest

sid-srini · 2025-09-08T08:57:33Z

Thank you @dbalek and @lahodaj. I will re-push after making the changes.

This is based on end-user feedback received in oracle/javavscode#197 1. Added a user preference for insertion of method parameters in code completions. - `"completion-insert-text-parameters"` - default value = `true` - Also available via: - ide/editor.lib2: `EditorPreferencesKeys.COMPLETION_INSERT_TEXT_PARAMETERS` - java/java.completion: `Utilities.isCompletionInsertTextParameters()` 2. Added disabling of the above preference from the LSP client via the client config key `PREFIX + "java.completion.disable.insertMethodParameters"` - Updation occurs in `TextDocumentServiceImpl.completion()` 3. Added an extra arg `insertTextParams` in the following interface methods with the default value `true`: - `JavaCompletionTask.ItemFactory`: - `createExecutableItem` - `createThisOrSuperConstructorItem` - `JavaCompletionTask.TypeCastableItemFactory`: - `createTypeCastableExecutableItem` 4. Invoked the above methods in `JavaCompletionTask` with this parameter value set by `Utilities.isCompletionInsertTextParameters()`. 5. Enhanced the implementations of the above methods in `JavaCompletionCollector` and `JavaCompletionItem` to insert text for method arguments when `insertTextParams` (or `!memberRef`). - The cursor would be placed inside the parentheses if it is not a no-args method completion. 6. Added a follow-up LSP command to the completion item "editor.action.triggerParameterHints" for showing the signature help when not inserting text parameters. - This is a necessary guide for the user. - It would not be triggered without this addition, since the trigger character '(' is not typed by the user. 7. Unrelated minor fixes in `JavaCompletionCollector.ItemFactoryImpl`: - Added the default prefix ("nbls") to the usages of the follow-up command "java.complete.abstract.methods". - Without this, the command would not get launched by the client. - Added to the builder in `createExecutableItem()`, the instantiated follow-up command "nbls.java.complete.abstract.methods". Signed-off-by: Siddharth Srinivasan <siddharth.srinivasan@oracle.com>

Incorporated review feedback about hoisting to existing if conditions; and adding few descriptive comments. Signed-off-by: Siddharth Srinivasan <siddharth.srinivasan@oracle.com>

Updated the java.completion module sig file after rebasing the PR to current master (release-300rc2+). Signed-off-by: Siddharth Srinivasan <siddharth.srinivasan@oracle.com>

sid-srini · 2026-04-29T10:07:18Z

I have rebased the PR commits to current master and updated the java.completion module sig file for the sigtest CI check. I'm sorry for the delay in doing this.

@lahodaj or @dbalek - Please re-run the CI checks and re-review this PR. Thank you so much.

lahodaj reviewed Sep 12, 2024

View reviewed changes

lahodaj requested a review from dbalek September 12, 2024 14:41

sid-srini mentioned this pull request Sep 12, 2024

[JVSC-197] Java completion enhanced to support no insertion of method parameters oracle/javavscode#267

Closed

mbien added the Java [ci] enable extra Java tests (java.completion, java.source.base, java.hints, refactoring.java, form) label Sep 12, 2024

lahodaj added LSP [ci] enable Language Server Protocol tests VSCode Extension labels Sep 13, 2024

sid-srini force-pushed the java_completion-methods_without_params branch from 2fbdd85 to bdcf822 Compare August 21, 2025 21:16

dbalek approved these changes Sep 1, 2025

View reviewed changes

sid-srini added 3 commits April 29, 2026 13:58

Java completion enhanced to support no insertion of method parameters

44d030a

Incorporated review feedback about hoisting to existing if conditions; and adding few descriptive comments. Signed-off-by: Siddharth Srinivasan <siddharth.srinivasan@oracle.com>

Java completion enhanced to support no insertion of method parameters

42c1a62

Updated the java.completion module sig file after rebasing the PR to current master (release-300rc2+). Signed-off-by: Siddharth Srinivasan <siddharth.srinivasan@oracle.com>

sid-srini force-pushed the java_completion-methods_without_params branch from bdcf822 to 42c1a62 Compare April 29, 2026 10:04

Conversation

sid-srini commented Sep 12, 2024

Uh oh!

lahodaj left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lahodaj Sep 12, 2024

Choose a reason for hiding this comment

Uh oh!

sid-srini Sep 12, 2024

Choose a reason for hiding this comment

Uh oh!

sid-srini Sep 12, 2024

Choose a reason for hiding this comment

Uh oh!

sid-srini commented Sep 12, 2024

Uh oh!

neilcsmith-net commented Sep 12, 2024

Uh oh!

sid-srini commented Sep 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

neilcsmith-net commented Sep 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sid-srini commented Aug 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dbalek left a comment

Choose a reason for hiding this comment

Uh oh!

lahodaj commented Sep 8, 2025

Uh oh!

sid-srini commented Sep 8, 2025

Uh oh!

sid-srini commented Apr 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

sid-srini commented Sep 12, 2024 •

edited

Loading

neilcsmith-net commented Sep 12, 2024 •

edited

Loading

sid-srini commented Aug 21, 2025 •

edited

Loading