com.plenigo.sdk.models.ElementList Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-sdk Show documentation

Java SDK wrapping plenigo REST-API for easier usage.

There is a newer version: 1.7.2

package com.plenigo.sdk.models;

import java.util.List;


/**
 * 
 * This class is used to represent an elements list.
 * 
 * 
 * Thread safety: This class is thread safe and can be injected.
 * 
 *
 * @param  type of list to support
 */
public class ElementList {
    private int pageNumber;
    private int size;
    private long totalElements;
    private List elements;

    /**
     * Builds an element list with the provided parameters.
     *
     * @param pageNumber    page number
     * @param size          page size
     * @param totalElements total amount of elements
     * @param elements      list of elements
     */
    public ElementList(int pageNumber, int size, long totalElements, List elements) {
        this.pageNumber = pageNumber;
        this.size = size;
        this.totalElements = totalElements;
        this.elements = elements;
    }

    /**
     * Returns the page number.
     *
     * @return page number
     */
    public int getPageNumber() {
        return pageNumber;
    }

    /**
     * Returns the page size.
     *
     * @return page size
     */
    public int getSize() {
        return size;
    }

    /**
     * Returns the list of elements.
     *
     * @return elements
     */
    public List getElements() {
        return elements;
    }

    /**
     * Return the total amount of elements.
     *
     * @return total amount of elements
     */
    public long getTotalElements() {
        return totalElements;
    }
}