Uses of Interface
org.springframework.hateoas.LinkRelation

Packages that use LinkRelation

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.collectionjson	Value objects to build Collection+JSON representations.
org.springframework.hateoas.mediatype.hal	HAL-specific extensions, SPIs and Jackson customizations.
org.springframework.hateoas.mediatype.uber	UBER media type objects.
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 LinkRelation in org.springframework.hateoas

Fields in org.springframework.hateoas declared as LinkRelation

Modifier and Type	Field and Description
static LinkRelation	IanaLinkRelations.ABOUT Refers to a resource that is the subject of the link's context.
static LinkRelation	IanaLinkRelations.ALTERNATE Refers to a substitute for this context
static LinkRelation	IanaLinkRelations.APPENDIX Refers to an appendix.
static LinkRelation	IanaLinkRelations.ARCHIVES Refers to a collection of records, documents, or other materials of historical interest.
static LinkRelation	IanaLinkRelations.AUTHOR Refers to the context's author.
static LinkRelation	IanaLinkRelations.BLOCKED_BY Identifies the entity that blocks access to a resource following receipt of a legal demand.
static LinkRelation	IanaLinkRelations.BOOKMARK Gives a permanent link to use for bookmarking purposes.
static LinkRelation	IanaLinkRelations.CANONICAL Designates the preferred version of a resource (the IRI and its contents).
static LinkRelation	IanaLinkRelations.CHAPTER Refers to a chapter in a collection of resources.
static LinkRelation	IanaLinkRelations.CITE_AS Indicates that the link target is preferred over the link context for the purpose of referencing.
static LinkRelation	IanaLinkRelations.COLLECTION The target IRI points to a resource which represents the collection resource for the context IRI.
static LinkRelation	IanaLinkRelations.CONTENTS Refers to a table of contents.
static LinkRelation	IanaLinkRelations.CONVERTED_FROM The document linked to was later converted to the document that contains this link relation.
static LinkRelation	IanaLinkRelations.COPYRIGHT Refers to a copyright statement that applies to the link's context.
static LinkRelation	IanaLinkRelations.CREATE_FORM The target IRI points to a resource where a submission form can be obtained.
static LinkRelation	IanaLinkRelations.CURRENT Refers to a resource containing the most recent item(s) in a collection of resources.
static LinkRelation	IanaLinkRelations.DESCRIBED_BY Refers to a resource providing information about the link's context.
static LinkRelation	IanaLinkRelations.DESCRIBES The relationship A 'describes' B asserts that resource A provides a description of resource B.
static LinkRelation	IanaLinkRelations.DISCLOSURE Refers to a list of patent disclosures made with respect to material for which 'disclosure' relation is specified.
static LinkRelation	IanaLinkRelations.DNS_PREFETCH Used to indicate an origin that will be used to fetch required resources for the link context, and that the user agent ought to resolve as early as possible.
static LinkRelation	IanaLinkRelations.DUPLICATE Refers to a resource whose available representations are byte-for-byte identical with the corresponding representations of the context IRI.
static LinkRelation	IanaLinkRelations.EDIT Refers to a resource that can be used to edit the link's context.
static LinkRelation	IanaLinkRelations.EDIT_FORM The target IRI points to a resource where a submission form for editing associated resource can be obtained.
static LinkRelation	IanaLinkRelations.EDIT_MEDIA Refers to a resource that can be used to edit media associated with the link's context.
static LinkRelation	IanaLinkRelations.ENCLOSURE Identifies a related resource that is potentially large and might require special handling.
static LinkRelation	IanaLinkRelations.FIRST An IRI that refers to the furthest preceding resource in a series of resources.
static LinkRelation	IanaLinkRelations.GLOSSARY Refers to a glossary of terms.
static LinkRelation	IanaLinkRelations.HELP Refers to context-sensitive help.
static LinkRelation	IanaLinkRelations.HOSTS Refers to a resource hosted by the server indicated by the link context.
static LinkRelation	IanaLinkRelations.HUB Refers to a hub that enables registration for notification of updates to the context.
static LinkRelation	IanaLinkRelations.ICON Refers to an icon representing the link's context.
static LinkRelation	IanaLinkRelations.INDEX Refers to an index.
static LinkRelation	IanaLinkRelations.INTERVAL_AFTER refers to a resource associated with a time interval that ends before the beginning of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.INTERVAL_BEFORE refers to a resource associated with a time interval that begins after the end of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.INTERVAL_CONTAINS refers to a resource associated with a time interval that begins after the beginning of the time interval associated with the context resource, and ends before the end of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.INTERVAL_DISJOINT refers to a resource associated with a time interval that begins after the end of the time interval associated with the context resource, or ends before the beginning of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.INTERVAL_DURING refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.INTERVAL_EQUALS refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.INTERVAL_FINISHED_BY refers to a resource associated with a time interval that begins after the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.INTERVAL_FINISHES refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.INTERVAL_IN refers to a resource associated with a time interval that begins before or is coincident with the beginning of the time interval associated with the context resource, and ends after or is coincident with the end of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.INTERVAL_MEETS refers to a resource associated with a time interval whose beginning coincides with the end of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.INTERVAL_MET_BY refers to a resource associated with a time interval whose beginning coincides with the end of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.INTERVAL_OVERLAPPED_BY refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and ends after the beginning of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.INTERVAL_OVERLAPS refers to a resource associated with a time interval that begins before the end of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.INTERVAL_STARTED_BY refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and ends before the end of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.INTERVAL_STARTS refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resource
static LinkRelation	IanaLinkRelations.ITEM The target IRI points to a resource that is a member of the collection represented by the context IRI.
static LinkRelation	IanaLinkRelations.LAST An IRI that refers to the furthest following resource in a series of resources.
static LinkRelation	IanaLinkRelations.LATEST_VERSION Points to a resource containing the latest (e.g., current) version of the context.
static LinkRelation	IanaLinkRelations.LICENSE Refers to a license associated with this context.
static LinkRelation	IanaLinkRelations.LRDD Refers to further information about the link's context, expressed as a LRDD ("Link-based Resource Descriptor Document") resource.
static LinkRelation	IanaLinkRelations.MEMENTO The Target IRI points to a Memento, a fixed resource that will not change state anymore.
static LinkRelation	IanaLinkRelations.MONITOR Refers to a resource that can be used to monitor changes in an HTTP resource.
static LinkRelation	IanaLinkRelations.MONITOR_GROUP Refers to a resource that can be used to monitor changes in a specified group of HTTP resources.
static LinkRelation	IanaLinkRelations.NEXT Indicates that the link's context is a part of a series, and that the next in the series is the link target.
static LinkRelation	IanaLinkRelations.NEXT_ARCHIVE Refers to the immediately following archive resource.
static LinkRelation	IanaLinkRelations.NOFOLLOW Indicates that the context’s original author or publisher does not endorse the link target.
static LinkRelation	IanaLinkRelations.NOREFERRER Indicates that no referrer information is to be leaked when following the link.
static LinkRelation	IanaLinkRelations.ORIGINAL The Target IRI points to an Original Resource.
static LinkRelation	IanaLinkRelations.PAYMENT Indicates a resource where payment is accepted.
static LinkRelation	IanaLinkRelations.PINGBACK Gives the address of the pingback resource for the link context.
static LinkRelation	IanaLinkRelations.PRECONNECT Used to indicate an origin that will be used to fetch required resources for the link context.
static LinkRelation	IanaLinkRelations.PREDECESSOR_VERSION Points to a resource containing the predecessor version in the version history.
static LinkRelation	IanaLinkRelations.PREFETCH The prefetch link relation type is used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch, such that the user agent can deliver a faster response once the resource is requested in the future.
static LinkRelation	IanaLinkRelations.PRELOAD Refers to a resource that should be loaded early in the processing of the link's context, without blocking rendering.
static LinkRelation	IanaLinkRelations.PRERENDER Used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch and execute, such that the user agent can deliver a faster response once the resource is requested in the future.
static LinkRelation	IanaLinkRelations.PREV Indicates that the link's context is a part of a series, and that the previous in the series is the link target.
static LinkRelation	IanaLinkRelations.PREV_ARCHIVE Refers to the immediately preceding archive resource.
static LinkRelation	IanaLinkRelations.PREVIEW Refers to a resource that provides a preview of the link's context.
static LinkRelation	IanaLinkRelations.PREVIOUS Refers to the previous resource in an ordered series of resources.
static LinkRelation	IanaLinkRelations.PRIVACY_POLICY Refers to a privacy policy associated with the link's context.
static LinkRelation	IanaLinkRelations.PROFILE Identifying that a resource representation conforms to a certain profile, without affecting the non-profile semantics of the resource representation.
static LinkRelation	Link.REL_FIRST Deprecated. Use IanaLinkRelations.FIRST instead.
static LinkRelation	Link.REL_LAST Deprecated. Use IanaLinkRelations.LAST instead.
static LinkRelation	Link.REL_NEXT Deprecated. Use IanaLinkRelations.NEXT instead.
static LinkRelation	Link.REL_PREVIOUS Deprecated. Use IanaLinkRelations.PREV instead.
static LinkRelation	Link.REL_SELF Deprecated. Use IanaLinkRelations.SELF instead.
static LinkRelation	IanaLinkRelations.RELATED Identifies a related resource.
static LinkRelation	IanaLinkRelations.REPLIES Identifies a resource that is a reply to the context of the link.
static LinkRelation	IanaLinkRelations.RESTCONF Identifies the root of RESTCONF API as configured on this HTTP server.
static LinkRelation	IanaLinkRelations.SEARCH Refers to a resource that can be used to search through the link's context and related resources.
static LinkRelation	IanaLinkRelations.SECTION Refers to a section in a collection of resources.
static LinkRelation	IanaLinkRelations.SELF Conveys an identifier for the link's context.
static LinkRelation	IanaLinkRelations.SERVICE Indicates a URI that can be used to retrieve a service document.
static LinkRelation	IanaLinkRelations.START Refers to the first resource in a collection of resources.
static LinkRelation	IanaLinkRelations.STYLESHEET Refers to a stylesheet.
static LinkRelation	IanaLinkRelations.SUBSECTION Refers to a resource serving as a subsection in a collection of resources.
static LinkRelation	IanaLinkRelations.SUCCESSOR_VERSION Points to a resource containing the successor version in the version history.
static LinkRelation	IanaLinkRelations.TAG Gives a tag (identified by the given address) that applies to the current document.
static LinkRelation	IanaLinkRelations.TERMS_OF_SERVICE Refers to the terms of service associated with the link's context.
static LinkRelation	IanaLinkRelations.TIMEGATE The Target IRI points to a TimeGate for an Original Resource.
static LinkRelation	IanaLinkRelations.TIMEMAP The Target IRI points to a TimeMap for an Original Resource.
static LinkRelation	IanaLinkRelations.TYPE Refers to a resource identifying the abstract semantic type of which the link's context is considered to be an instance.
static LinkRelation	IanaLinkRelations.UP Refers to a parent document in a hierarchy of documents.
static LinkRelation	IanaLinkRelations.VERSION_HISTORY Points to a resource containing the version history for the context.
static LinkRelation	IanaLinkRelations.VIA Identifies a resource that is the source of the information in the link's context.
static LinkRelation	IanaLinkRelations.WEBMENTION Identifies a target URI that supports the Webmention protcol.
static LinkRelation	IanaLinkRelations.WORKING_COPY Points to a working copy for this resource.
static LinkRelation	IanaLinkRelations.WORKING_COPY_OF Points to the versioned resource from which this working copy was obtained.

Methods in org.springframework.hateoas that return LinkRelation

Modifier and Type	Method and Description
static LinkRelation	LinkRelation.of(String relation) Creates a new LinkRelation.
static LinkRelation	IanaLinkRelations.parse(String relation) Convert a string-based link relation to a IanaLinkRelations.

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

Modifier and Type	Method and Description
static Iterable<LinkRelation>	LinkRelation.manyOf(String... others) Creates a new Iterable of LinkRelation for each of the given Strings.

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

Modifier and Type	Method and Description
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.
List<Link>	RepresentationModel.getLinks(LinkRelation relation) Returns all Links with the given relation.
Link	RepresentationModel.getRequiredLink(LinkRelation relation) Returns the link with the given relation.
Link	Links.getRequiredLink(LinkRelation relation) Returns the Link with the given relation.
boolean	RepresentationModel.hasLink(LinkRelation rel)
boolean	Links.hasLink(LinkRelation relation) Returns whether the current Links contains a Link with the given relation.
boolean	Link.hasRel(LinkRelation rel) Returns whether the Link has the given LinkRelation.
static boolean	IanaLinkRelations.isIanaRel(LinkRelation relation) Is this relation an IANA standard?
default boolean	LinkRelation.isSameAs(LinkRelation relation) Returns whether the given LinkRelation is logically the same as the current one, independent of implementation, i.e. whether the plain String values match.
Links	Links.without(LinkRelation relation) Returns a Links with all Links with the given LinkRelation removed.
Link	Link.withRel(LinkRelation relation) Creates a new Link with the same href but given LinkRelation.

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

Constructor and Description
Link(String href, LinkRelation rel) Creates a new Link to the given URI with the given rel.
Link(UriTemplate template, LinkRelation rel) Creates a new Link from the given UriTemplate and rel.

Uses of LinkRelation in org.springframework.hateoas.client

Methods in org.springframework.hateoas.client with parameters of type LinkRelation

Modifier and Type	Method and Description
protected Link	JsonPathLinkDiscoverer.extractLink(Object element, LinkRelation rel) Callback for each LinkDiscoverer to extract relevant attributes and generate a Link.
Links	JsonPathLinkDiscoverer.findLinksWithRel(LinkRelation relation, InputStream representation)
Links	LinkDiscoverer.findLinksWithRel(LinkRelation relation, InputStream representation) Returns all links with the given LinkRelation found in the given InputStream representation.
Links	JsonPathLinkDiscoverer.findLinksWithRel(LinkRelation relation, String representation)
Links	LinkDiscoverer.findLinksWithRel(LinkRelation relation, String representation) Returns all links with the given LinkRelation found in the given String representation.
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 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.

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

Methods in org.springframework.hateoas.mediatype.collectionjson with parameters of type LinkRelation

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

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

Classes in org.springframework.hateoas.mediatype.hal that implement LinkRelation

Modifier and Type	Class and Description
class	HalLinkRelation Value object for HAL based LinkRelation, i.e. a relation that can be curied.

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

Modifier and Type	Method and Description
protected Link	HalLinkDiscoverer.extractLink(Object element, LinkRelation rel)
HalLinkRelation	CurieProvider.getNamespacedRelFor(LinkRelation rel) Returns the rel to be rendered for the given rel.
HalLinkRelation	DefaultCurieProvider.getNamespacedRelFor(LinkRelation relation)
static HalLinkRelation	HalLinkRelation.of(LinkRelation relation) Returns a HalLinkRelation for the given general LinkRelation.
HalConfiguration	HalConfiguration.withRenderSingleLinksFor(LinkRelation relation, HalConfiguration.RenderSingleLinks renderSingleLinks) Configures how to render a single link for a given particular LinkRelation.

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

Methods in org.springframework.hateoas.mediatype.uber with parameters of type LinkRelation

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

Uses of LinkRelation in org.springframework.hateoas.server

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

Modifier and Type	Method and Description
LinkRelation	LinkRelationProvider.getCollectionResourceRelFor(Class<?> type) Returns the relation type to be used to point to a collection resource of the given type.
LinkRelation	LinkRelationProvider.getItemResourceRelFor(Class<?> type) Returns the relation type to be used to point to an item resource of the given type.

Methods in org.springframework.hateoas.server with parameters of type LinkRelation

Modifier and Type	Method and Description
Link	LinkBuilder.withRel(LinkRelation rel) Creates the Link built by the current builder instance with the given LinkRelation.

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

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

Modifier and Type	Method and Description
LinkRelation	DelegatingLinkRelationProvider.getCollectionResourceRelFor(Class<?> type)
LinkRelation	AnnotationLinkRelationProvider.getCollectionResourceRelFor(Class<?> type)
LinkRelation	EvoInflectorLinkRelationProvider.getCollectionResourceRelFor(Class<?> type)
LinkRelation	DefaultLinkRelationProvider.getCollectionResourceRelFor(Class<?> type)
LinkRelation	DelegatingLinkRelationProvider.getItemResourceRelFor(Class<?> type)
LinkRelation	AnnotationLinkRelationProvider.getItemResourceRelFor(Class<?> type)
LinkRelation	DefaultLinkRelationProvider.getItemResourceRelFor(Class<?> type)

Methods in org.springframework.hateoas.server.core that return types with arguments of type LinkRelation

Modifier and Type	Method and Description
Optional<LinkRelation>	EmbeddedWrapper.getRel() Returns the rel to be used when embedding.

Methods in org.springframework.hateoas.server.core with parameters of type LinkRelation

Modifier and Type	Method and Description
boolean	EmbeddedWrapper.hasRel(LinkRelation rel) Returns whether the wrapper has the given rel.
Link	LinkBuilderSupport.withRel(LinkRelation rel)
EmbeddedWrapper	EmbeddedWrappers.wrap(Object source, LinkRelation rel) Creates a new EmbeddedWrapper with the given rel.

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

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

Modifier and Type	Method and Description
LinkRelation	ControllerLinkRelationProvider.getCollectionResourceRelFor(Class<?> resource)
LinkRelation	ControllerLinkRelationProvider.getItemResourceRelFor(Class<?> resource)

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

Methods in org.springframework.hateoas.server.reactive with parameters of type LinkRelation

Modifier and Type	Method and Description
WebFluxLinkBuilder.WebFluxLink	WebFluxLinkBuilder.WebFluxBuilder.withRel(LinkRelation relation) Creates a new WebFluxLinkBuilder.WebFluxLink for the Link with the given LinkRelation