java/com/google/gerrit/extensions/restapi/RestCollectionView.java

// Copyright (C) 2018 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.extensions.restapi;

/**
 * RestView on a RestCollection that supports accepting input.
 *
 * <p>The input must be supplied as JSON as the body of the HTTP request. RestCollectionViews can
 * only be invoked by the HTTP method {@code POST}.
 *
 * @param <P> type of the parent resource
 * @param <C> type of the child resource
 * @param <I> type of input the JSON parser will parse the input into.
 */
public interface RestCollectionView<P extends RestResource, C extends RestResource, I>
    extends RestView<C> {

  Object apply(P parentResource, I input) throws Exception;
}