io.quarkus.hal.HalCollectionWrapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-hal Show documentation

Hypertext Application Language (HAL) support

The newest version!

package io.quarkus.hal;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

import jakarta.ws.rs.core.Link;

/**
 * The Hal collection wrapper that includes the list of Hal entities {@link HalEntityWrapper}, the collection name and the Hal
 * links.
 *
 * This type is serialized into Json using:
 * - the JSON-B serializer: {@link HalCollectionWrapperJsonbSerializer}
 * - the Jackson serializer: {@link HalCollectionWrapperJacksonSerializer}
 */
public class HalCollectionWrapper extends HalWrapper {

    private final Collection> collection;
    private final String collectionName;

    public HalCollectionWrapper(Collection> collection, String collectionName, Link... links) {
        this(collection, collectionName, new HashMap<>());

        addLinks(links);
    }

    public HalCollectionWrapper(Collection> collection, String collectionName, Map links) {
        super(links);

        this.collection = collection;
        this.collectionName = collectionName;
    }

    public Collection> getCollection() {
        return collection;
    }

    public String getCollectionName() {
        return collectionName;
    }

}