org.springframework.hateoas.server

Class TypedEntityLinks.ExtendedTypedEntityLinks<T>

java.lang.Object

org.springframework.hateoas.server.TypedEntityLinks<T>

org.springframework.hateoas.server.TypedEntityLinks.ExtendedTypedEntityLinks<T>

Enclosing class:

TypedEntityLinks<T>

public static class TypedEntityLinks.ExtendedTypedEntityLinks<T>
extends TypedEntityLinks<T>

Extension of TypedEntityLinks that exposes the ability to create links to collection resources as well.

Author:

Oliver Drotbohm

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.hateoas.server.TypedEntityLinks

TypedEntityLinks.ExtendedTypedEntityLinks<T>

Method Summary

Modifier and Type	Method and Description
Link	linkToCollectionResource() Creates a Link pointing to the collection resource of the configured type.

Methods inherited from class org.springframework.hateoas.server.TypedEntityLinks

linkForItemResource, linkToItemResource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

linkToCollectionResource

public Link linkToCollectionResource()

Creates a Link pointing to the collection resource of the configured type. The relation type of the link will be determined by the implementation class and should be defaulted to IanaLinkRelations.SELF.

Parameters:

type - the entity type to point to, must not be null.

Returns:

the Link pointing to the collection resource exposed for the configured entity type. Will never be null.

Throws:

IllegalArgumentException - in case the given type is unknown the entity links infrastructure.