BaseServlet: Add Javadoc for IOException to prevent Eclipse warnings

dpursehouse · dpursehouse · commit 3863a1e554c9 · 2019-06-01T15:34:52.000+09:00
The IOException is not thrown from the methods as implemented in the base class, but from the overridden implementations in the derived classes. Add Javadoc @throws tags to prevent Eclipse from complaining that the exceptions are not thrown. Change-Id: I55a225a80b819b2156c52fffe0e2f87482a5abb5
diff --git a/java/com/google/gitiles/BaseServlet.java b/java/com/google/gitiles/BaseServlet.java
@@ -145,6 +145,7 @@ protected FormatType getDefaultFormat(HttpServletRequest req) {
    *
    * @param req in-progress request.
    * @param res in-progress response.
+   * @throws IOException if there was an error rendering the result.
    */
   protected void doGetHtml(HttpServletRequest req, HttpServletResponse res) throws IOException {
     throw new GitilesRequestFailureException(FailureReason.UNSUPPORTED_RESPONSE_FORMAT);
@@ -155,6 +156,7 @@ protected void doGetHtml(HttpServletRequest req, HttpServletResponse res) throws
    *
    * @param req in-progress request.
    * @param res in-progress response.
+   * @throws IOException if there was an error rendering the result.
    */
   protected void doGetText(HttpServletRequest req, HttpServletResponse res) throws IOException {
     throw new GitilesRequestFailureException(FailureReason.UNSUPPORTED_RESPONSE_FORMAT);
@@ -165,6 +167,7 @@ protected void doGetText(HttpServletRequest req, HttpServletResponse res) throws
    *
    * @param req in-progress request.
    * @param res in-progress response.
+   * @throws IOException if there was an error rendering the result.
    */
   protected void doGetJson(HttpServletRequest req, HttpServletResponse res) throws IOException {
     throw new GitilesRequestFailureException(FailureReason.UNSUPPORTED_RESPONSE_FORMAT);
