pro.taskana.common.rest.models.PagedResources Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of taskana-rest-spring Show documentation

The taskana rest logic.

There is a newer version: 8.2.0

package pro.taskana.common.rest.models;

import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Objects;
import org.springframework.hateoas.Link;
import org.springframework.hateoas.PagedModel.PageMetadata;
import org.springframework.hateoas.RepresentationModel;

/**
 * Base Class for CollectionModel with pagination.
 *
 * @param  The Class of the paginatied content
 */
public class PagedResources extends RepresentationModel> {

  private final Collection content;

  private final PageMetadata metadata;

  /** Default constructor to allow instantiation by reflection. */
  protected PagedResources() {
    this(new ArrayList<>(), null);
  }

  /**
   * Creates a new {@link PagedResources} from the given content, {@link PageMetadata} and {@link
   * Link}s (optional).
   *
   * @param content must not be {@literal null}.
   * @param metadata the metadata
   * @param links the links
   */
  public PagedResources(Collection content, PageMetadata metadata, Link... links) {
    this(content, metadata, Arrays.asList(links));
  }

  /**
   * Creates a new {@link PagedResources} from the given content {@link PageMetadata} and {@link
   * Link}s.
   *
   * @param content must not be {@literal null}.
   * @param metadata the metadata
   * @param links the links
   */
  public PagedResources(Collection content, PageMetadata metadata, Iterable links) {
    super();
    this.content = content;
    this.metadata = metadata;
    this.add(links);
  }

  /**
   * Returns the pagination metadata.
   *
   * @return the metadata
   */
  @JsonProperty("page")
  public PageMetadata getMetadata() {
    if (Objects.isNull(metadata)) {
      Collection contentCollection = getContent();
      return new PageMetadata(contentCollection.size(), 0, contentCollection.size());
    }
    return metadata;
  }

  /**
   * Returns the content.
   *
   * @return the content
   */
  @JsonProperty("content")
  public Collection getContent() {
    return Collections.unmodifiableCollection(content);
  }

}