Spring/spring-hateoas
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#1639 - Javadoc polishing in preparation of stringer linting in JDK 17.

Browse Source
This commit is contained in:
Oliver Drotbohm
2021-09-21 14:09:47 +02:00
parent 690ea3e967
commit fc99a84439
9 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
pom.xml
View File

@@ -1049,16 +1049,16 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.4</version>
<version>3.3.1</version>
<configuration>
<breakiterator>true</breakiterator>
<header>${project.name}</header>
<source>${source.level}</source>
<quiet>true</quiet>
<additionalparam>-Xdoclint:none</additionalparam>
<doclint>none</doclint>
<links>
<link>https://docs.spring.io/spring/docs/5.1.x/javadoc-api</link>
<link>https://docs.oracle.com/javase/8/docs/api</link>
<link>https://docs.spring.io/spring/docs/${spring.version}/javadoc-api/</link>
<link>https://docs.oracle.com/javase/8/docs/api/</link>
</links>
</configuration>
</plugin>

3
src/main/java/org/springframework/hateoas/AffordanceModel.java
View File

@@ -241,7 +241,8 @@ public abstract class AffordanceModel {
* @param <T>
* @param target
* @return
* @deprecated since 1.3, prefer setting up the model types via {@link #createProperties(Function)}
* @deprecated since 1.3, prefer setting up the model types via
* {@link AffordanceModel#createProperties(BiFunction)}.
*/
@Deprecated
default <T extends PropertyMetadataConfigured<T> & Named> T applyTo(T target) {

6
src/main/java/org/springframework/hateoas/CollectionModel.java
View File

@@ -168,7 +168,7 @@ public class CollectionModel<T> extends RepresentationModel<CollectionModel<T>>
* @param content must not be {@literal null}.
* @return
* @since 1.1
* @see #withFallbackType(Class)
* @see #withFallbackType(Class, Class...)
* @see #withFallbackType(ResolvableType)
*/
public static <T> CollectionModel<T> of(Iterable<T> content) {
@@ -182,7 +182,7 @@ public class CollectionModel<T> extends RepresentationModel<CollectionModel<T>>
* @param links the links to be added to the {@link CollectionModel}.
* @return
* @since 1.1
* @see #withFallbackType(Class)
* @see #withFallbackType(Class, Class...)
* @see #withFallbackType(ResolvableType)
*/
public static <T> CollectionModel<T> of(Iterable<T> content, Link... links) {
@@ -196,7 +196,7 @@ public class CollectionModel<T> extends RepresentationModel<CollectionModel<T>>
* @param links the links to be added to the {@link CollectionModel}.
* @return
* @since 1.1
* @see #withFallbackType(Class)
* @see #withFallbackType(Class, Class...)
* @see #withFallbackType(ResolvableType)
*/
public static <T> CollectionModel<T> of(Iterable<T> content, Iterable<Link> links) {

2
src/main/java/org/springframework/hateoas/IanaUriSchemes.java
View File

@@ -23,7 +23,7 @@ import java.util.HashSet;
* A list of well-defined URI schemes governed by IANA.
*
* @author Oliver Drotbohm
* @see <a href="https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml>Official IANA URI scheme registry</a>
* @see <a href="https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml">Official IANA URI scheme registry</a>
* @since 1.2
*/
public class IanaUriSchemes {

2
src/main/java/org/springframework/hateoas/mediatype/AffordanceOperations.java
View File

@@ -22,7 +22,7 @@ import org.springframework.hateoas.Link;
* Operations commons to all builder APIs.
*
* @author Oliver Drotbohm
* @see AffordanceBuilder
* @see ConfigurableAffordance
*/
public interface AffordanceOperations {

6
src/main/java/org/springframework/hateoas/mediatype/ConfigurableAffordance.java
View File

@@ -166,15 +166,15 @@ public interface ConfigurableAffordance extends AffordanceOperations {
Affordances build();
/**
* Create a new {@link AffordanceBuilder} by copying all attributes and replacing the {@literal target}.
* Create a new {@link ConfigurableAffordance} by copying all attributes and replacing the {@literal target}.
*
* @param target
* @param target must not be {@literal null}.
* @return
*/
ConfigurableAffordance withTarget(Link target);
/**
* Create a new {@link AffordanceBuilder} by copying all attributes and replacing the {@literal name}.
* Create a new {@link ConfigurableAffordance} by copying all attributes and replacing the {@literal name}.
*
* @param name can be {@literal null}.
* @return

5
src/main/java/org/springframework/hateoas/mediatype/hal/HalModelBuilder.java
View File

@@ -30,7 +30,6 @@ import org.springframework.hateoas.MediaTypes;
import org.springframework.hateoas.RepresentationModel;
import org.springframework.hateoas.server.core.EmbeddedWrappers;
import org.springframework.lang.Nullable;
import org.springframework.ui.Model;
import org.springframework.util.Assert;
import com.fasterxml.jackson.annotation.JsonUnwrapped;
@@ -251,7 +250,7 @@ public class HalModelBuilder {
/**
* Initiates the setup of a preview given the current payload. Clients have to conclude the setup calling any of the
* {@link EntityPreviewBuilder#forLink(Link)} methods. As an example, the call chain of:
* {@link PreviewBuilder#forLink(Link)} methods. As an example, the call chain of:
*
* <pre>
* ….preview(…).forLink("…", "relation")
@@ -314,7 +313,7 @@ public class HalModelBuilder {
/**
* Add a {@link Link} to the whole thing.
* <p/>
* NOTE: This adds it to the top level. If you need a link inside an entity, then use the {@link Model.Builder} to
* NOTE: This adds it to the top level. If you need a link inside an entity, then use the {@link HalModelBuilder} to
* define it as well.
*
* @param link must not be {@literal null}.

2
src/main/java/org/springframework/hateoas/mediatype/html/HtmlInputType.java
View File

@@ -144,7 +144,7 @@ public class HtmlInputType {
/**
* Returns the {@link HtmlInputType} derived from the given {@link ResolvableType}.
*
* @param resolvableType must not be {@literal null}.
* @param type must not be {@literal null}.
* @return
*/
@Nullable

10
src/main/java/org/springframework/hateoas/server/EntityLinks.java
View File

@@ -25,9 +25,9 @@ import org.springframework.util.Assert;
/**
* Accessor to links pointing to controllers backing an entity type. The {@link IllegalArgumentException} potentially
* thrown by the declared methods will only appear if the {@link #supports(Class)} method has returned {@literal false}
* and the method has been invoked anyway, i.e. if {@link #supports(Class)} returns {@literal true} it's safe to invoke
* the interface methods an the exception will never be thrown.
* thrown by the declared methods will only appear if the {@link Plugin#supports(Class)} method has returned
* {@literal false} and the method has been invoked anyway, i.e. if {@link Plugin#supports(Class)} returns
* {@literal true} it's safe to invoke the interface methods an the exception will never be thrown.
*
* @author Oliver Gierke
*/
@@ -69,7 +69,7 @@ public interface EntityLinks extends Plugin<Class<?>> {
* Returns a {@link LinkBuilder} able to create links to the controller managing the given entity type and identifier
* extractor. Implementations will know about the URI structure being used to expose item-resource URIs.
*
* @param type the entity to point to, must not be {@literal null}.
* @param entity the entity to point to, must not be {@literal null}.
* @param identifierExtractor an extractor function to determine the id of the given entity, must not be
* {@literal null}.
* @return the {@link LinkBuilder} pointing to the item resource identified by the given entity. Will never be
@@ -111,7 +111,7 @@ public interface EntityLinks extends Plugin<Class<?>> {
* type of the link will be determined by the implementation class and should be defaulted to
* {@link IanaLinkRelations#SELF}.
*
* @param type the entity to point to, must not be {@literal null}.
* @param entity the entity to point to, must not be {@literal null}.
* @param identifierExtractor an extractor function to determine the id of the given entity.
* @return the {@link Link} pointing to the resource exposed for the given entity. Will never be {@literal null}.
* @throws IllegalArgumentException in case the given type is unknown the entity links infrastructure.