Uploaded image for project: 'Accumulo'
  1. Accumulo
  2. ACCUMULO-259 ZKAuthentictor needs to be split up
  3. ACCUMULO-1026

Don't use @Deprecated to mean "Not for Client Use"

    XMLWordPrintableJSON

Details

    • Sub-task
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • None
    • 1.5.0
    • master, tserver
    • None

    Description

      I understand the convenience of using "@Deprecated" to discourage users from using some bit of code, but I think this is confusing to users, because it doesn't actually mean the functionality is deprecated. This sets a bad precedent, because users may start getting the impression that when we say something is deprecated, we don't really mean it, that we're just keeping something from them.

      Further, using this tag liberally for other purposes, requires us to pollute the code with suppression of warnings, which may hide other potential issues. This wouldn't be an issue if the code were actually deprecated, because we should no longer be using the code ourselves.

      These extra tags got checked in for ACCUMULO-259, and I think they should be cleaned up.

      Some options are:

      1. Create another annotation for annotating the public API
      2. Create an annotation for annotating "Not For Client Use" when it is inconvenient to remove a method from the API.
      3. Use an interface so the method isn't exposed in our public API

      Attachments

        Activity

          People

            ctubbsii Christopher Tubbs
            ctubbsii Christopher Tubbs
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: