From 36d2e8c2f4cb7a4fb70593df574cd9a2d4d1bde4 Mon Sep 17 00:00:00 2001 From: Oliver Drotbohm Date: Tue, 9 Jul 2019 12:19:23 +0200 Subject: [PATCH] #1016 - Fix documentation on RelProvider, now LinkRelationProvider. Adapted reference documentation section as well as the migration docs. --- src/main/asciidoc/migrate-to-1.0.adoc | 1 + src/main/asciidoc/server.adoc | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/src/main/asciidoc/migrate-to-1.0.adoc b/src/main/asciidoc/migrate-to-1.0.adoc index e6d6e593..450bd501 100644 --- a/src/main/asciidoc/migrate-to-1.0.adoc +++ b/src/main/asciidoc/migrate-to-1.0.adoc @@ -33,6 +33,7 @@ Also the name changes have been reflected in the classes contained in `TypeRefer * The `LinkDiscoverer` API has been moved to the `client` package. * The `LinkBuilder` and `EntityLinks` APIs have been moved to the `server` package. * `ControllerLinkBuilder` has been moved into `server.mvc` and deprecated to be replaced by `WebMvcLinkBuilder`. +* `RelProvider` has been renamed to `LinkRelationProvider` and returns `LinkRelation` instances instead of `String`s. * `VndError` has been moved to the `mediatype.vnderror` package. [[migrate-to-1.0.script]] diff --git a/src/main/asciidoc/server.adoc b/src/main/asciidoc/server.adoc index 7bf4ad6b..06694aba 100644 --- a/src/main/asciidoc/server.adoc +++ b/src/main/asciidoc/server.adoc @@ -486,13 +486,13 @@ Also, in this example, the `PaymentProcessor` alters the provided `EntityModel> for details) transparently look up the relation types for the type configured in the annotation, so that you can use `relProvider.getItemResourceRelFor(MyController.class)` and get the relation type of the domain type exposed. +. `@Controller` classes annotated with `@ExposesResourceFor` (see <> for details) transparently look up the relation types for the type configured in the annotation, so that you can use `LinkRelationProvider.getItemResourceRelFor(MyController.class)` and get the relation type of the domain type exposed. -A `RelProvider` is automatically exposed as a Spring bean when you use `@EnableHypermediaSupport`. You can plug in custom providers by implementing the interface and exposing them as Spring beans in turn. +A `LinkRelationProvider` is automatically exposed as a Spring bean when you use `@EnableHypermediaSupport`. You can plug in custom providers by implementing the interface and exposing them as Spring beans in turn.