Uses of Class
org.springframework.hateoas.Link

Packages that use Link

Package	Description
org.springframework.hateoas	Value objects to ease creating Links and link driven representations for REST webservices.
org.springframework.hateoas.client	Client side support.
org.springframework.hateoas.mediatype	Spring container configuration support.
org.springframework.hateoas.mediatype.collectionjson	Value objects to build Collection+JSON representations.
org.springframework.hateoas.mediatype.hal	HAL-specific extensions, SPIs and Jackson customizations.
org.springframework.hateoas.mediatype.hal.forms	HAL-FORMS extension media type.
org.springframework.hateoas.mediatype.uber	UBER media type objects.
org.springframework.hateoas.mediatype.vnderrors	Vnd.Error media type.
org.springframework.hateoas.server	Server-side components for hypermedia handling.
org.springframework.hateoas.server.core	Implementations of core API interfaces.
org.springframework.hateoas.server.mvc	Spring MVC helper classes to build Links and assemble RepresentationModel types.
org.springframework.hateoas.server.reactive	Spring WebFlux components to build Links and assemble RepresentationModel types.

Uses of Link in org.springframework.hateoas

Methods in org.springframework.hateoas that return Link

Modifier and Type	Method	Description
Link	Link.andAffordance(Affordance affordance)	Create new Link with an additional Affordance.
Link	Link.andAffordances(List<Affordance> affordances)	Create new Link with additional Affordances.
Link	Link.expand(Object... arguments)	Turns the current template into a Link by expanding it using the given parameters.
Link	Link.expand(Map<String,?> arguments)	Turns the current template into a Link by expanding it using the given parameters.
Link	AffordanceModel.getLink()
Link	Links.getRequiredLink(String rel)	Returns the Link with the given relation.
Link	Links.getRequiredLink(LinkRelation relation)	Returns the Link with the given relation.
Link	RepresentationModel.getRequiredLink(String relation)	Returns the link with the given relation.
Link	RepresentationModel.getRequiredLink(LinkRelation relation)	Returns the link with the given relation.
static Link	Link.of(String href)	Creates a new link to the given URI with the self relation.
static Link	Link.of(String href, String relation)	Creates a new Link to the given href with the given relation.
static Link	Link.of(String href, LinkRelation relation)	Creates a new Link to the given href and LinkRelation.
static Link	Link.of(UriTemplate template, String relation)	Creates a new Link to the given UriTemplate and link relation.
static Link	Link.of(UriTemplate template, LinkRelation relation)	Creates a new Link to the given UriTemplate and LinkRelation.
static Link	Link.valueOf(String source)	Factory method to easily create Link instances from RFC-8288 compatible String representations of a link.
Link	Link.withAffordances(List<Affordance> affordances)	Creates a new Link with the given Affordances.
Link	Link.withDeprecation(String deprecation)	Create a new Link by copying all attributes and applying the new deprecation.
Link	Link.withHref(String href)	Create a new Link by copying all attributes and applying the new href.
Link	Link.withHreflang(String hreflang)	Create a new Link by copying all attributes and applying the new hreflang.
Link	Link.withMedia(String media)	Create a new Link by copying all attributes and applying the new media.
Link	Link.withName(String name)	Create a new Link by copying all attributes and applying the new name.
Link	Link.withProfile(String profile)	Create a new Link by copying all attributes and applying the new profile.
Link	Link.withRel(String relation)	Creates a new Link with the same href but given LinkRelation.
Link	Link.withRel(LinkRelation relation)	Creates a new Link with the same href but given LinkRelation.
Link	Link.withSelfRel()	Returns a Link pointing to the same URI but with the self relation.
Link	Link.withTitle(String title)	Create a new Link by copying all attributes and applying the new title.
Link	Link.withType(String type)	Create a new Link by copying all attributes and applying the new type.

Methods in org.springframework.hateoas that return types with arguments of type Link

Modifier and Type	Method	Description
static Collector<Link,?,Links>	Links.collector()	Creates a new Collector to collect a Stream of Links into a Links instance.
Optional<Link>	Links.getLink(String relation)	Returns a Link with the given relation if contained in the current Links instance, Optional.empty() otherwise.
Optional<Link>	Links.getLink(LinkRelation rel)	Returns the Link with the given rel.
Optional<Link>	RepresentationModel.getLink(String relation)	Returns the link with the given relation.
Optional<Link>	RepresentationModel.getLink(LinkRelation relation)	Returns the link with the given LinkRelation.
List<Link>	RepresentationModel.getLinks(String relation)	Returns all Links with the given relation.
List<Link>	RepresentationModel.getLinks(LinkRelation relation)	Returns all Links with the given relation.
Optional<Link>	PagedModel.getNextLink()	Returns the Link pointing to the next page (if set).
Optional<Link>	SlicedModel.getNextLink()	Returns the Link pointing to the next slice (if set).
Optional<Link>	PagedModel.getPreviousLink()	Returns the Link pointing to the previous page (if set).
Optional<Link>	SlicedModel.getPreviousLink()	Returns the Link pointing to the previous slice (if set).
Iterator<Link>	Links.iterator()
Stream<Link>	Links.stream()	Creates a Stream of the current Links.
List<Link>	Links.toList()	Returns the current Links as List.

Methods in org.springframework.hateoas with parameters of type Link

Modifier and Type	Method	Description
T	RepresentationModel.add(Link link)	Adds the given link to the resource.
T	RepresentationModel.add(Link... links)	Adds all given Links to the resource.
Links	Links.and(Link... links)	Creates a new Links instance with all given Links added.
final Links	Links.andIf(boolean condition, Link... links)	Adds the given links if the given condition is true.
boolean	Links.contains(Link... links)	Returns whether the current Links contain all given Links (but potentially others).
static <T> CollectionModel<T>	CollectionModel.empty(Link... links)	Creates a new empty collection model with the given links.
static <T> PagedModel<T>	PagedModel.empty(Link... links)	Creates an empty PagedModel with the given links.
static <T> PagedModel<T>	PagedModel.empty(PagedModel.PageMetadata metadata, Link... links)	Creates an empty PagedModel with the given PagedModel.PageMetadata and links.
static <T> SlicedModel<T>	SlicedModel.empty(Link... links)	Creates an empty SlicedModel with the given links.
static <T> SlicedModel<T>	SlicedModel.empty(SlicedModel.SliceMetadata metadata, Link... links)	Creates an empty SlicedModel with the given SlicedModel.SliceMetadata and links.
Links	Links.merge(Link... links)	Merges the current Links with the given ones, skipping Links already contained in the current instance.
Links	Links.merge(Links.MergeMode mode, Link... links)	Merges the current Links with the given ones applying the given Links.MergeMode.
static <T> CollectionModel<T>	CollectionModel.of(Iterable<T> content, Link... links)	Creates a CollectionModel instance with the given content and Links (optional).
static <T> EntityModel<T>	EntityModel.of(T content, Link... links)	Creates a new EntityModel with the given content and Links (optional).
static Links	Links.of(Link... links)	Creates a new Links instance from the given Links.
static <T> PagedModel<T>	PagedModel.of(Collection<T> content, PagedModel.PageMetadata metadata, Link... links)	Creates a new PagedModel from the given content, PagedModel.PageMetadata and Links (optional).
static <T> SlicedModel<T>	SlicedModel.of(Collection<T> content, SlicedModel.SliceMetadata metadata, Link... links)	Creates a new SlicedModel from the given content, SlicedModel.SliceMetadata and Links (optional).
boolean	AffordanceModel.pointsToTargetOf(Link link)	Returns whether the Affordance points to the target of the given Link.

Method parameters in org.springframework.hateoas with type arguments of type Link

Modifier and Type	Method	Description
T	RepresentationModel.add(Iterable<Link> links)	Adds all given Links to the resource.
T	RepresentationModel.addAllIf(boolean guard, Supplier<? extends Iterable<Link>> links)	Adds all Links produced by the given Supplier if the guard is true.
T	RepresentationModel.addIf(boolean guard, Supplier<Link> link)	Adds the Link produced by the given Supplier if the guard is true.
Links	Links.and(Iterable<Link> links)	Creates a new Links instance with all given Links added.
Links	Links.and(Stream<Link> links)	Creates a new Links instance with all given Links added.
final Links	Links.andIf(boolean condition, Stream<Link> links)	Adds the given links if the given condition is true.
boolean	Links.contains(Iterable<Link> links)	Returns whether the current Links contain all given Links (but potentially others).
boolean	Links.containsSameLinksAs(Iterable<Link> links)	Returns whether the current Links instance contains exactly the same Link as the given one.
static <T> CollectionModel<T>	CollectionModel.empty(Iterable<Link> links)	Creates a new empty collection model with the given links.
static <T> PagedModel<T>	PagedModel.empty(Iterable<Link> links)	Creates an empty PagedModel with the given links.
static <T> PagedModel<T>	PagedModel.empty(PagedModel.PageMetadata metadata, Iterable<Link> links)	Creates an empty PagedModel with the given PagedModel.PageMetadata and links.
static <T> SlicedModel<T>	SlicedModel.empty(Iterable<Link> links)	Creates an empty SlicedModel with the given links.
static <T> SlicedModel<T>	SlicedModel.empty(SlicedModel.SliceMetadata metadata, Iterable<Link> links)	Creates an empty SlicedModel with the given SlicedModel.SliceMetadata and links.
T	RepresentationModel.mapLink(LinkRelation relation, Function<Link,Link> mapper)	Replaces the link(s) with the given LinkRelation with the mapper applied to each of the links.
T	RepresentationModel.mapLink(LinkRelation relation, Function<Link,Link> mapper)	Replaces the link(s) with the given LinkRelation with the mapper applied to each of the links.
T	RepresentationModel.mapLinkIf(boolean condition, LinkRelation relation, Function<Link,Link> mapper)	Replaces the link(s) with the given LinkRelation with the mapper applied to each of the links if the given condition is true.
T	RepresentationModel.mapLinkIf(boolean condition, LinkRelation relation, Function<Link,Link> mapper)	Replaces the link(s) with the given LinkRelation with the mapper applied to each of the links if the given condition is true.
Links	Links.merge(Iterable<Link> links)	Merges the current Links with the given ones, skipping Links already contained in the current instance.
Links	Links.merge(Stream<Link> links)	Merges the current Links with the given ones, skipping Links already contained in the current instance.
Links	Links.merge(Links.MergeMode mode, Iterable<Link> links)	Merges the current Links with the given ones applying the given Links.MergeMode.
Links	Links.merge(Links.MergeMode mode, Stream<Link> links)	Merges the current Links with the given ones applying the given Links.MergeMode.
static <T> EntityModel<T>	EntityModel.of(T content, Iterable<Link> links)	Creates a new EntityModel with the given content and Links.
static Links	Links.of(Iterable<Link> links)	Creates a new Links instance from the given Links.
static <T> PagedModel<T>	PagedModel.of(Collection<T> content, PagedModel.PageMetadata metadata, Iterable<Link> links)	Creates a new PagedModel from the given content PagedModel.PageMetadata and Links.
static <T> RepresentationModel<?>	RepresentationModel.of(T object, Iterable<Link> links)	Creates a new RepresentationModel for the given content object and links.
static <T> SlicedModel<T>	SlicedModel.of(Collection<T> content, SlicedModel.SliceMetadata metadata, Iterable<Link> links)	Creates a new SlicedModel from the given content SlicedModel.SliceMetadata and Links.

Constructors in org.springframework.hateoas with parameters of type Link

Modifier	Constructor	Description
	AffordanceModel(String name, Link link, HttpMethod httpMethod, AffordanceModel.InputPayloadMetadata input, List<QueryParameter> queryMethodParameters, AffordanceModel.PayloadMetadata output)
	RepresentationModel(Link initialLink)

Constructor parameters in org.springframework.hateoas with type arguments of type Link

Modifier	Constructor	Description
protected	EntityModel(T content, Iterable<Link> links)	Creates a new EntityModel with the given content and Links.
protected	PagedModel(Collection<T> content, PagedModel.PageMetadata metadata, Iterable<Link> links)
protected	PagedModel(Collection<T> content, PagedModel.PageMetadata metadata, Iterable<Link> links, ResolvableType fallbackType)
	RepresentationModel(Iterable<Link> initialLinks)
protected	SlicedModel(Collection<T> content, SlicedModel.SliceMetadata metadata, Iterable<Link> links)
protected	SlicedModel(Collection<T> content, SlicedModel.SliceMetadata metadata, Iterable<Link> links, ResolvableType fallbackType)

Uses of Link in org.springframework.hateoas.client

Methods in org.springframework.hateoas.client that return Link

Modifier and Type	Method	Description
Link	Traverson.TraversalBuilder.asLink()	Returns the Link found for the last rel in the rels configured to follow.
Link	Traverson.TraversalBuilder.asTemplatedLink()	Returns the templated Link found for the last relation in the rels configured to follow.
protected Link	JsonPathLinkDiscoverer.extractLink(Object element, LinkRelation rel)	Callback for each LinkDiscoverer to extract relevant attributes and generate a Link.
default Link	LinkDiscoverer.findRequiredLinkWithRel(LinkRelation relation, InputStream representation)	Finds a single link with the given relation type in the given InputStream representation.
default Link	LinkDiscoverer.findRequiredLinkWithRel(LinkRelation relation, String representation)	Finds a single link with the given relation in the given String representation.

Methods in org.springframework.hateoas.client that return types with arguments of type Link

Modifier and Type	Method	Description
Optional<Link>	JsonPathLinkDiscoverer.findLinkWithRel(LinkRelation relation, InputStream representation)
Optional<Link>	JsonPathLinkDiscoverer.findLinkWithRel(LinkRelation relation, String representation)
default Optional<Link>	LinkDiscoverer.findLinkWithRel(String relation, InputStream representation)	Finds a single link with the given relation type in the given InputStream representation.
default Optional<Link>	LinkDiscoverer.findLinkWithRel(String relation, String representation)	Finds a single link with the given relation type in the given String representation.
Optional<Link>	LinkDiscoverer.findLinkWithRel(LinkRelation relation, InputStream representation)	Finds a single link with the given LinkRelation in the given InputStream representation.
Optional<Link>	LinkDiscoverer.findLinkWithRel(LinkRelation relation, String representation)	Finds a single link with the given LinkRelation in the given String representation.

Uses of Link in org.springframework.hateoas.mediatype

Methods in org.springframework.hateoas.mediatype that return Link

Modifier and Type	Method	Description
Link	ConfiguredAffordance.getTarget()	Returns the affordance's target.
Link	AffordanceOperations.toLink()	Returns a Link equipped with the Affordance currently under construction.
Link	Affordances.toLink()

Methods in org.springframework.hateoas.mediatype with parameters of type Link

Modifier and Type	Method	Description
static Affordances	Affordances.of(Link link)
ConfigurableAffordance	ConfigurableAffordance.withTarget(Link target)	Create a new ConfigurableAffordance by copying all attributes and replacing the target.

Uses of Link in org.springframework.hateoas.mediatype.collectionjson

Methods in org.springframework.hateoas.mediatype.collectionjson that return types with arguments of type Link

Modifier and Type	Method	Description
Optional<Link>	CollectionJsonLinkDiscoverer.findLinkWithRel(LinkRelation relation, InputStream representation)
Optional<Link>	CollectionJsonLinkDiscoverer.findLinkWithRel(LinkRelation relation, String representation)

Uses of Link in org.springframework.hateoas.mediatype.hal

Subclasses of Link in org.springframework.hateoas.mediatype.hal

Modifier and Type	Class	Description
protected static class	DefaultCurieProvider.Curie	Value object to get the curie Link rendered in JSON.
class	LinkMixin	Custom mixin to avoid rel attributes being rendered for HAL.

Methods in org.springframework.hateoas.mediatype.hal that return Link

Modifier and Type	Method	Description
protected Link	HalLinkDiscoverer.extractLink(Object element, LinkRelation rel)
static Link	LinkMixin.of(String href)

Methods in org.springframework.hateoas.mediatype.hal that return types with arguments of type Link

Modifier and Type	Method	Description
List<Link>	Jackson2HalModule.HalLinkListDeserializer.deserialize(com.fasterxml.jackson.core.JsonParser jp, com.fasterxml.jackson.databind.DeserializationContext ctxt)

Methods in org.springframework.hateoas.mediatype.hal with parameters of type Link

Modifier and Type	Method	Description
HalModelBuilder	HalModelBuilder.PreviewBuilder.forLink(Link link)	Concludes the set up of a preview for the given Link.
HalLinkRelation	CurieProvider.getNamespacedRelFrom(Link link)	Returns the rel to be rendered for the given Link.
HalLinkRelation	DefaultCurieProvider.getNamespacedRelFrom(Link link)
HalModelBuilder	HalModelBuilder.link(Link link)	Add a Link to the whole thing.

Method parameters in org.springframework.hateoas.mediatype.hal with type arguments of type Link

Modifier and Type	Method	Description
HalModelBuilder	HalModelBuilder.links(Iterable<Link> links)	Adds the given Links to the RepresentationModel to be built.

Uses of Link in org.springframework.hateoas.mediatype.hal.forms

Methods in org.springframework.hateoas.mediatype.hal.forms that return Link

Modifier and Type	Method	Description
Link	HalFormsOptions.Remote.getLink()	Returns the Link pointing to the resource returning option values.

Methods in org.springframework.hateoas.mediatype.hal.forms with parameters of type Link

Modifier and Type	Method	Description
static HalFormsOptions.Remote	HalFormsOptions.remote(Link link)	Creates a new HalFormsOptions.Remote options representation using the given Link.

Uses of Link in org.springframework.hateoas.mediatype.uber

Methods in org.springframework.hateoas.mediatype.uber that return types with arguments of type Link

Modifier and Type	Method	Description
Optional<Link>	UberLinkDiscoverer.findLinkWithRel(LinkRelation rel, InputStream representation)
Optional<Link>	UberLinkDiscoverer.findLinkWithRel(LinkRelation rel, String representation)

Uses of Link in org.springframework.hateoas.mediatype.vnderrors

Methods in org.springframework.hateoas.mediatype.vnderrors with parameters of type Link

Modifier and Type	Method	Description
VndErrors	VndErrors.withLink(Link link)	Deprecated.
VndErrors	VndErrors.withLinks(Link... links)	Deprecated.

Constructors in org.springframework.hateoas.mediatype.vnderrors with parameters of type Link

Modifier	Constructor	Description
	VndError(String message, String path, Object logref, Link... link)	Deprecated.
	VndError(String logref, String message, Link... links)	Deprecated. Use VndError(String, String, Object, Link...) (with proper ordering of arguments)
	VndErrors(Object logref, String message, Link... links)	Deprecated. Creates a new VndErrors instance containing a single VndErrors.VndError with the given logref, message and optional Links.

Constructor parameters in org.springframework.hateoas.mediatype.vnderrors with type arguments of type Link

Modifier	Constructor	Description
	VndError(String message, String path, Object logref, List<Link> links)	Deprecated. Creates a new VndErrors.VndError with a message and optional a path and a logref.

Uses of Link in org.springframework.hateoas.server

Methods in org.springframework.hateoas.server that return Link

Modifier and Type	Method	Description
Link	EntityLinks.linkToCollectionResource(Class<?> type)	Creates a Link pointing to the collection resource of the given type.
Link	TypedEntityLinks.ExtendedTypedEntityLinks.linkToCollectionResource()	Creates a Link pointing to the collection resource of the configured type.
Link	EntityLinks.linkToItemResource(Class<?> type, Object id)	Creates a Link pointing to item resource backing the given entity type and id.
default <T> Link	EntityLinks.linkToItemResource(T entity, Function<T,Object> identifierExtractor)	Creates a Link pointing to item resource backing the given entity and identifier extractor.
Link	TypedEntityLinks.linkToItemResource(T entity)	Creates a Link pointing to item resource backing the given entity.
default Link	LinkBuilder.withRel(String rel)	Creates the Link built by the current builder instance with the given link relation.
Link	LinkBuilder.withRel(LinkRelation rel)	Creates the Link built by the current builder instance with the given LinkRelation.
Link	LinkBuilder.withSelfRel()	Creates the Link built by the current builder instance with the default self link relation.

Uses of Link in org.springframework.hateoas.server.core

Methods in org.springframework.hateoas.server.core that return Link

Modifier and Type	Method	Description
Link	ControllerEntityLinks.linkToCollectionResource(Class<?> entity)
Link	DelegatingEntityLinks.linkToCollectionResource(Class<?> type)
Link	ControllerEntityLinks.linkToItemResource(Class<?> entity, Object id)
Link	DelegatingEntityLinks.linkToItemResource(Class<?> type, Object id)
Link	LinkBuilderSupport.withRel(LinkRelation rel)
Link	LinkBuilderSupport.withSelfRel()

Uses of Link in org.springframework.hateoas.server.mvc

Methods in org.springframework.hateoas.server.mvc that return Link

Modifier and Type	Method	Description
static Link	MvcLink.of(Object invocation)	Creates a new Link from the given MvcUriComponentsBuilder invocation defaulting to the IanaLinkRelations.SELF link relation.
static Link	MvcLink.of(Object invocation, LinkRelation relation)	Creates a new Link from the given MvcUriComponentsBuilder invocation.
static Link	MvcLink.of(Supplier<Object> invocation)	Creates a new Link from the given lazy MvcUriComponentsBuilder invocation defaulting to the IanaLinkRelations.SELF link relation.
static Link	MvcLink.of(Supplier<Object> invocation, LinkRelation relation)	Creates a new Link from the given lazy MvcUriComponentsBuilder invocation.

Uses of Link in org.springframework.hateoas.server.reactive

Methods in org.springframework.hateoas.server.reactive that return types with arguments of type Link

Modifier and Type	Method	Description
reactor.core.publisher.Mono<Link>	WebFluxLinkBuilder.WebFluxLink.toMono()	Returns the underlying Mono of Link for further handling within a reactive pipeline.
reactor.core.publisher.Mono<Link>	WebFluxLinkBuilder.WebFluxLink.toMono(Function<Link,Link> finisher)	Returns a Mono of Link with the current one augmented by the given Function.

Method parameters in org.springframework.hateoas.server.reactive with type arguments of type Link

Modifier and Type	Method	Description
WebFluxLinkBuilder.WebFluxLink	WebFluxLinkBuilder.WebFluxLink.map(Function<Link,Link> mapper)	Creates a new WebFluxLinkBuilder.WebFluxLink with the current Link instance transformed using the given mapper.
WebFluxLinkBuilder.WebFluxLink	WebFluxLinkBuilder.WebFluxLink.map(Function<Link,Link> mapper)	Creates a new WebFluxLinkBuilder.WebFluxLink with the current Link instance transformed using the given mapper.
WebFluxLinkBuilder.WebFluxLink	WebFluxLinkBuilder.WebFluxBuilder.toLink(Function<WebFluxLinkBuilder,reactor.core.publisher.Mono<Link>> finisher)	General callback to produce a Link from the given WebFluxLinkBuilder.
reactor.core.publisher.Mono<Link>	WebFluxLinkBuilder.WebFluxLink.toMono(Function<Link,Link> finisher)	Returns a Mono of Link with the current one augmented by the given Function.
reactor.core.publisher.Mono<Link>	WebFluxLinkBuilder.WebFluxLink.toMono(Function<Link,Link> finisher)	Returns a Mono of Link with the current one augmented by the given Function.

Constructor parameters in org.springframework.hateoas.server.reactive with type arguments of type Link

Modifier	Constructor	Description
	WebFluxLink(reactor.core.publisher.Mono<Link> link)