Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Need ability to add very specific exceptions #17

Open
keith-turner opened this issue Apr 13, 2015 · 5 comments
Open

Need ability to add very specific exceptions #17

keith-turner opened this issue Apr 13, 2015 · 5 comments
Assignees

Comments

@keith-turner
Copy link
Member

While analyzing Accumulo's API I have run into some mistakes made in the past. For example AbstractInputFormat has a method called getTabletLocator() that returns a non public API type. I would like to add a very specific exception to ignore this method.

@ctubbsii
Copy link
Member

One simple way to add an exception currently is to mark the mistake with @ Deprecated . Is there a use case for ignoring specific non-deprecated problems?

@keith-turner
Copy link
Member Author

One simple way to add an exception currently is to mark the mistake with @ Deprecated .

If its an existing problem that one does not have the time to deal with (like deprecate and provide a replacement), its nice to have the option to ignore it.

@ctubbsii
Copy link
Member

One possible concern: learning the syntax for exceptions may be more burdensome than deprecating, in many cases, and will likely not be very frequently used. As such, the potential extra complexity to add to the plugin may not be worth it if people aren't going to use it.

Another use case: if you actually want to analyze deprecated code (for whatever reason) and need a different way to declare an exception.

@keith-turner keith-turner self-assigned this Sep 1, 2015
@keith-turner keith-turner added this to the 1.1.0 milestone Sep 1, 2015
@keith-turner
Copy link
Member Author

I changed the milestone to 1.1.0 because I think this important for initial adoption. Users can start using the plugin, ignoring existing problems. In this scenario users can get the benefit of preventing new problems in the API immediately.

@ctubbsii ctubbsii modified the milestones: 1.1.0, 1.2.0 Oct 5, 2017
@ctubbsii ctubbsii removed this from the 1.2.0 milestone Dec 16, 2017
@keith-turner
Copy link
Member Author

Could offer a specific annotation that instructs Apilyzer to ignore problems in a method or class.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants