src/main/java/org/apache/sling/graphql/api/pagination/Connection.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.sling.graphql.api.pagination;

import org.jetbrains.annotations.NotNull;
import org.osgi.annotation.versioning.ConsumerType;

/**
 * The {@code Connection} interface provides support for implementing the Connection Types, according to the specification from
 *
 * <a href="https://relay.dev/graphql/connections.htm#sec-Connection-Types">https://relay.dev/graphql/connections.htm#sec-Connection-Types</a>.
 */
@ConsumerType
public interface Connection<T> {

    @NotNull Iterable<Edge<T>> getEdges();

    @NotNull PageInfo getPageInfo();
}