Line data    Source code

       1             : // Copyright (C) 2018 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.ChangeMessageInfo;
      18             : import com.google.gerrit.extensions.restapi.NotImplementedException;
      19             : import com.google.gerrit.extensions.restapi.RestApiException;
      20             : 
      21             : /** Interface for change message APIs. */
      22             : public interface ChangeMessageApi {
      23             :   /** Gets one change message. */
      24             :   ChangeMessageInfo get() throws RestApiException;
      25             : 
      26             :   /**
      27             :    * Deletes a change message by replacing its message. For NoteDb, it's implemented by rewriting
      28             :    * the commit history of change meta branch.
      29             :    *
      30             :    * @return the change message with its message updated.
      31             :    */
      32             :   ChangeMessageInfo delete(DeleteChangeMessageInput input) throws RestApiException;
      33             : 
      34             :   /**
      35             :    * A default implementation which allows source compatibility when adding new methods to the
      36             :    * interface.
      37             :    */
      38           0 :   class NotImplemented implements ChangeMessageApi {
      39             :     @Override
      40             :     public ChangeMessageInfo get() throws RestApiException {
      41           0 :       throw new NotImplementedException();
      42             :     }
      43             : 
      44             :     @Override
      45             :     public ChangeMessageInfo delete(DeleteChangeMessageInput input) throws RestApiException {
      46           0 :       throw new NotImplementedException();
      47             :     }
      48             :   }
      49             : }