java/com/google/gerrit/server/restapi/change/HumanCommentFilter.java

// Copyright (C) 2020 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.gerrit.server.restapi.change;

import com.google.common.collect.ImmutableList;
import com.google.gerrit.entities.HumanComment;

/** Filter for human comments. */
public interface HumanCommentFilter {

  /**
   * Filters the given comments. The returned comments are the ones which still remain after this
   * filter was applied.
   *
   * @param comments comments which should be filtered
   * @return remaining comments. Must not include comments which weren't included in the given
   *     comments.
   */
  ImmutableList<HumanComment> filter(ImmutableList<HumanComment> comments);
}