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.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 and 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(Map<String,?> arguments) Turns the current template into a Link by expanding it using the given parameters.
Link	Link.expand(Object... arguments) Turns the current template into a Link by expanding it using the given parameters.
Link	RepresentationModel.getRequiredLink(LinkRelation relation) 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	Links.getRequiredLink(String rel) Returns the Link with the given relation.
static Link	Link.valueOf(String element) Factory method to easily create Link instances from RFC-5988 compatible String representations of a link.
Link	Link.withAffordances(List<Affordance> affordances) Creats a new Link with the given Affordances.
Link	Link.withRel(LinkRelation relation) Creates a new Link with the same href but given LinkRelation.
Link	Link.withRel(String 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.

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

Modifier and Type	Method and Description
static Collector<Link,?,Links>	Links.collector() Creates a new Collector to collect a Stream of Links into a Links instance.
Optional<Link>	RepresentationModel.getLink(LinkRelation relation) Returns the link with the given LinkRelation.
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>	Links.getLink(String relation) Returns a Link with the given relation if contained in the current Links instance, Optional.empty() otherwise.
List<Link>	RepresentationModel.getLinks(LinkRelation relation) Returns all Links with the given relation.
List<Link>	RepresentationModel.getLinks(String relation) Returns all Links with the given relation.
Optional<Link>	PagedModel.getNextLink() Returns the Link pointing to the next page (if set).
Optional<Link>	PagedModel.getPreviousLink() Returns the Link pointing to the previous page (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 and Description
T	RepresentationModel.add(Link... links) Adds all given Links to the resource.
T	RepresentationModel.add(Link link) Adds the given link to the resource.
Links	Links.and(Link... links) Creates a new Links instance with all given Links added.
boolean	Links.contains(Link... links) Returns whether the current Links contain all given Links (but potentially others).
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 Links	Links.of(Link... links) Creates a new Links instance from the given Links.
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 and 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.
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.
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(Links.MergeMode mode, Iterable<Link> links) Merges the current Links with the given ones applying the given Links.MergeMode.
static Links	Links.of(Iterable<Link> links) Creates a new Links instance from the given Links.

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

Constructor and Description
CollectionModel(Iterable<T> content, Link... links) Creates a CollectionModel instance with the given content and Links (optional).
EntityModel(T content, Link... links) Creates a new EntityModel with the given content and Links (optional).
PagedModel(Collection<T> content, PagedModel.PageMetadata metadata, Link... links) Creates a new PagedModel from the given content, PagedModel.PageMetadata and Links (optional).
RepresentationModel(Link initialLink)

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

Constructor and Description
CollectionModel(Iterable<T> content, Iterable<Link> links) Creates a CollectionModel instance with the given content and Links.
EntityModel(T content, Iterable<Link> links) Creates a new EntityModel with the given content and Links.
PagedModel(Collection<T> content, PagedModel.PageMetadata metadata, Iterable<Link> links) Creates a new PagedModel from the given content PagedModel.PageMetadata and Links.
RepresentationModel(List<Link> initialLinks)

Uses of Link in org.springframework.hateoas.client

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

Modifier and Type	Method and 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 and Description
Optional<Link>	JsonPathLinkDiscoverer.findLinkWithRel(LinkRelation relation, InputStream representation)
Optional<Link>	LinkDiscoverer.findLinkWithRel(LinkRelation relation, InputStream representation) Finds a single link with the given LinkRelation in the given InputStream representation.
Optional<Link>	JsonPathLinkDiscoverer.findLinkWithRel(LinkRelation relation, String representation)
Optional<Link>	LinkDiscoverer.findLinkWithRel(LinkRelation rel, String representation) Finds a single link with the given LinkRelation in the given 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 rel, String representation) Finds a single link with the given relation type 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 and Description
Link	Affordances.toLink()
Link	Affordances.AffordanceBuilder.toLink()
Link	AffordanceOperations.toLink() Returns a Link equipped with the Affordance currently under construction.

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

Modifier and Type	Method and Description
AffordanceModel	AffordanceModelFactory.getAffordanceModel(String name, Link link, HttpMethod httpMethod, AffordanceModel.InputPayloadMetadata inputType, List<QueryParameter> queryMethodParameters, AffordanceModel.PayloadMetadata outputType) Look up the AffordanceModel for this factory.

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 and 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 and 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 and Description
protected Link	HalLinkDiscoverer.extractLink(Object element, LinkRelation rel)

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

Modifier and Type	Method and 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 and Description
HalLinkRelation	CurieProvider.getNamespacedRelFrom(Link link) Returns the rel to be rendered for the given Link.
HalLinkRelation	DefaultCurieProvider.getNamespacedRelFrom(Link link)

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

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

Modifier and Type	Method and Description
HalFormsDocument<T>	HalFormsDocument.andLink(Link link) Adds the given Link to the current document.

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 and 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

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

Constructor and Description
VndError(String logref, String message, Link... links) Creates a new VndErrors.VndError with the given logref, a message as well as some Links.
VndErrors(String logref, String message, Link... links) Creates a new VndErrors instance containing a single VndErrors.VndError with the given logref, message and optional Links.

Uses of Link in org.springframework.hateoas.server

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

Modifier and Type	Method and Description
Link	TypedEntityLinks.ExtendedTypedEntityLinks.linkToCollectionResource() Creates a Link pointing to the collection resource of the configured type.
Link	EntityLinks.linkToCollectionResource(Class<?> type) Creates a Link pointing to the collection resource of the given type.
Link	EntityLinks.linkToItemResource(Class<?> type, Object id) Creates a Link pointing to item resource backing the given entity type and id.
Link	TypedEntityLinks.linkToItemResource(T entity) Creates a Link pointing to item resource backing the given entity.
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	LinkBuilder.withRel(LinkRelation rel) Creates the Link built by the current builder instance with the given LinkRelation.
default Link	LinkBuilder.withRel(String rel) Creates the Link built by the current builder instance with the given link relation.
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 and 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.reactive

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

Modifier and Type	Method and 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 and 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.