Ensure auto-replacement of deprecated methods in IntelliJ

[TimvdLippe]

Per https://blog.jetbrains.com/idea/2017/10/intellij-idea-2017-3-public-preview IntelliJ can now auto-suggest replacements for deprecated methods. Once IntelliJ 2017-3 is published, let's check whether our deprecations satisfy the requirements for this check.

Maybe we can also write a static analysis check that can automatically verify that whenever we deprecated method we:

1. Link to a replacement
2. Add @since property
3. Is only removed in the next major version (See getArgumentAt is removed in 2.7.6 #945 as example)

[mureinik]

It shouldn't be too difficult to cook up a Checkstyle check that identifies a deprecated method/class that doesn't have a @link or @see tag in its javadoc. I'm not quite sure where the right place for such a check would be though.

Can the maintainers advise on the proper place within the project structure?

[TimvdLippe]

I think this should be in the checkstyle.xml and then any custom implementation code in a new folder. I have this issue planned for today, so will report how far I can get :)

…

On Sat, 28 Oct 2017, 12:09 Allon Murienik, ***@***.***> wrote: It shouldn't be too difficult to cook up a Checkstyle check that identifies a deprecated method/class that doesn't have a @link or @see tag in its javadoc. I'm not quite sure where the right place for such a check would be though. Can the maintainers advise on the proper place within the project structure? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#1225 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AFrDb10gZ_hHrmAAsRa2AW0HY3bHw6_hks5swv11gaJpZM4QI6So> .

[TimvdLippe]

So I have tried to make this work for the past couple of hours, but unsuccesfully. I am unable to get the check implementation on the classpath to actually be recognized by the checkstyle configuration. If you have any knowledge of how to do this with checkstyle and Gradle, please let me know. Sadly http://checkstyle.sourceforge.net/writingchecks.html is lackluster in this regard.

[TimvdLippe]

Oh, my attempt is available at https://github.com/mockito/mockito/tree/custom-checkstyle

[TimvdLippe]

Intellij 2017.3 has been released: https://www.jetbrains.com/idea/whatsnew/#v2017-3

[TimvdLippe]

I no longer think we should pursue this effort.