com.jayway.jaxrs.hateoas.LinkProducer Maven / Gradle / Ivy
/*
* Copyright 2011 the original author or authors.
* Licensed 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 com.jayway.jaxrs.hateoas;
import java.util.Collection;
/**
* Callback interface to be used for generating custom links for items.
*
* @author Mattias Hellborg Arthursson
* @author Kalle Stenflo
* @see com.jayway.jaxrs.hateoas.core.HateoasResponse.HateoasResponseBuilder#each(LinkProducer)
*/
public interface LinkProducer {
/**
* Produce links for an item.
*
* @param entity the entity to produce links for.
* @return one or more links to be added for the entity.
*/
Collection getLinks(T entity);
}