rest-util/src/main/java/org/apache/archiva/components/rest/model/PagedResult.java

package org.apache.archiva.components.rest.model;

/*
 * 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.
 */

import io.swagger.v3.oas.annotations.media.Schema;

import javax.xml.bind.annotation.XmlRootElement;
import java.util.List;

/**
 * A Paged result puts the data into an envelope
 * @author Martin Stockhammer <martin_s@apache.org>
 */
@XmlRootElement(name="pagedResult")
@Schema(name = "PagedResult", description = "Contains paged data. Pages are defined by limit and offset.")
public class PagedResult<T>
{
    PaginationInfo pagination;
    List<T> data;

    public PagedResult() {

    }

    public PagedResult( int totalCount, int offset, int limit, List<T> data ) {
        this.data = data;
        this.pagination = new PaginationInfo( totalCount, offset, limit );
    }

    public static final <T> PagedResult<T> of(int totalSize, int offset, int limit, List<T> element) {
        return new PagedResult( totalSize, offset, limit, element);
    }

    @Schema(description = "This is the payload of the paged data. The type of data depends on the REST method. ")
    public List<T> getData( )
    {
        return data;
    }

    public void setData( List<T> data )
    {
        this.data = data;
    }

    @Schema(description = "The pagination information")
    public PaginationInfo getPagination( )
    {
        return pagination;
    }

    public void setPagination( PaginationInfo pagination )
    {
        this.pagination = pagination;
    }
}