RFR: 8241187: ToolBox::grep should allow for negative filtering [v3]

[Jonathan Gibbons]

On Fri, 23 Apr 2021 12:01:31 GMT, Guoxiong Li <gli at openjdk.org> wrote:

>> Hi all,
>> 
>> This patch adds two methods in `ToolBox` to do the negative filtering. Although the label `noreg-self` was added, I write a test for this enhancement to verify the code. And the method name `grepNotMatch` may need to be improved. Any idea is appreciated.
>>  
>> Thank you for taking the time to review.
>> 
>> Best Regards.
>
> Guoxiong Li has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains four additional commits since the last revision:
> 
>  - Use meaningful class name
>  - Merge branch 'master' into JDK-8241187
>  - Revise method and test.
>  - 8241187: ToolBox::grep should allow for negative filtering

Changes requested by jjg (Reviewer).

test/langtools/tools/lib/toolbox/ToolBox.java line 192:

> 190:      * @param invert identify positive or negative filtering
> 191:      *               true: negative filtering, return the unmatched strings
> 192:      *               false: positive filtering, return the matched strings

This is not a particularly well-formed javadoc comment.  Imagine the output if you were to run the file through javadoc.

Suggest:

Filters a list of strings according to the given regular expression,
returning either the strings that match or the strings that do not match.
@param regex the regular expression
@param lines the strings to be filtered
@param invert if true, return the lines that do not match; otherwise if false, return the lines that do match.


The `invert` parameter feels "inverted" leading to a "double negative".

Maybe it would be better to call the parameter "match" and invert the sense, so the doc comment reads:


Filters a list of strings according to the given regular expression,
returning either the strings that match or the strings that do not match.
@param regex the regular expression
@param lines the strings to be filtered
@param match if true, return the lines that match; otherwise if false, return the lines that do not match.

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

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