Line data    Source code

       1             : // Copyright (C) 2014 The Android Open Source Project
       2             : //
       3             : // Licensed under the Apache License, Version 2.0 (the "License");
       4             : // you may not use this file except in compliance with the License.
       5             : // You may obtain a copy of the License at
       6             : //
       7             : // http://www.apache.org/licenses/LICENSE-2.0
       8             : //
       9             : // Unless required by applicable law or agreed to in writing, software
      10             : // distributed under the License is distributed on an "AS IS" BASIS,
      11             : // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      12             : // See the License for the specific language governing permissions and
      13             : // limitations under the License.
      14             : 
      15             : package com.google.gerrit.extensions.api.changes;
      16             : 
      17             : import com.google.gerrit.extensions.common.CommentInfo;
      18             : import com.google.gerrit.extensions.restapi.NotImplementedException;
      19             : import com.google.gerrit.extensions.restapi.RestApiException;
      20             : 
      21             : public interface CommentApi {
      22             :   CommentInfo get() throws RestApiException;
      23             : 
      24             :   /**
      25             :    * Deletes a published comment of a revision. For NoteDb, it deletes the comment by rewriting the
      26             :    * commit history.
      27             :    *
      28             :    * <p>Note instead of deleting the whole comment, this endpoint just replaces the comment's
      29             :    * message.
      30             :    *
      31             :    * @return the comment with its message updated.
      32             :    */
      33             :   CommentInfo delete(DeleteCommentInput input) throws RestApiException;
      34             : 
      35             :   /**
      36             :    * A default implementation which allows source compatibility when adding new methods to the
      37             :    * interface.
      38             :    */
      39           0 :   class NotImplemented implements CommentApi {
      40             :     @Override
      41             :     public CommentInfo get() throws RestApiException {
      42           0 :       throw new NotImplementedException();
      43             :     }
      44             : 
      45             :     @Override
      46             :     public CommentInfo delete(DeleteCommentInput input) throws RestApiException {
      47           0 :       throw new NotImplementedException();
      48             :     }
      49             :   }
      50             : }