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

#1856 - Polishing.

Browse Source 
Imports, formatting, Javadoc. Ticket references in test cases.
This commit is contained in:
Oliver Drotbohm
2023-02-28 15:28:48 +01:00
parent 7229cbdbdc
commit 132ca62702
2 changed files with 94 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

130
src/main/java/org/springframework/hateoas/SlicedModel.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2022 the original author or authors.
* Copyright 2022-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,7 +15,13 @@
*/
package org.springframework.hateoas;
import java.util.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.core.ResolvableType;
@@ -29,8 +35,11 @@ import com.fasterxml.jackson.annotation.JsonProperty;
* DTO to implement binding response representations of Slice collections.
*
* @author Michael Schout
* @author Oliver Drotbohm
* @since 2.1
*/
public class SlicedModel<T> extends CollectionModel<T> {
public static SlicedModel<?> NO_SLICE = new SlicedModel<>();
private final SliceMetadata metadata;
@@ -53,6 +62,7 @@ public class SlicedModel<T> extends CollectionModel<T> {
protected SlicedModel(Collection<T> content, @Nullable SliceMetadata metadata, Iterable<Link> links,
@Nullable ResolvableType fallbackType) {
super(content, links, fallbackType);
this.metadata = metadata;
@@ -62,7 +72,7 @@ public class SlicedModel<T> extends CollectionModel<T> {
/**
* Creates an empty {@link SlicedModel}.
*
* @param <T>
* @param <T> the payload type.
* @return will never be {@literal null}.
*/
public static <T> SlicedModel<T> empty() {
@@ -72,7 +82,7 @@ public class SlicedModel<T> extends CollectionModel<T> {
/**
* Creates an empty {@link SlicedModel} with the given fallback type.
*
* @param <T>
* @param <T> the payload type.
* @param fallbackElementType must not be {@literal null}.
* @param generics must not be {@literal null}.
* @return will never be {@literal null}.
@@ -85,7 +95,7 @@ public class SlicedModel<T> extends CollectionModel<T> {
/**
* Creates an empty {@link SlicedModel} with the given fallback type.
*
* @param <T>
* @param <T> the payload type.
* @param fallbackElementType must not be {@literal null}.
* @return will never be {@literal null}.
* @see #withFallbackType(ParameterizedTypeReference)
@@ -97,7 +107,7 @@ public class SlicedModel<T> extends CollectionModel<T> {
/**
* Creates an empty {@link SlicedModel} with the given fallback type.
*
* @param <T>
* @param <T> the payload type.
* @param fallbackElementType must not be {@literal null}.
* @return will never be {@literal null}.
* @see #withFallbackType(ResolvableType)
@@ -109,9 +119,9 @@ public class SlicedModel<T> extends CollectionModel<T> {
/**
* Creates an empty {@link SlicedModel} with the given links.
*
* @param <T>
* @param <T> the payload type.
* @param links must not be {@literal null}.
* @return
* @return will never be {@literal null}.
*/
public static <T> SlicedModel<T> empty(Link... links) {
return empty(null, links);
@@ -120,9 +130,9 @@ public class SlicedModel<T> extends CollectionModel<T> {
/**
* Creates an empty {@link SlicedModel} with the given links.
*
* @param <T>
* @param <T> the payload type.
* @param links must not be {@literal null}.
* @return
* @return will never be {@literal null}.
*/
public static <T> SlicedModel<T> empty(Iterable<Link> links) {
return empty(null, links);
@@ -131,19 +141,18 @@ public class SlicedModel<T> extends CollectionModel<T> {
/**
* Creates an empty {@link SlicedModel} with the given {@link SliceMetadata}.
*
* @param <T>
* @param <T> the payload type.
* @param metadata can be {@literal null}.
* @return
* @return will never be {@literal null}.
*/
public static <T> SlicedModel<T> empty(@Nullable SliceMetadata metadata) {
return empty(metadata, Collections.emptyList());
}
/**
* Creates an empty {@link SlicedModel} with the given {@link SliceMetadata} and fallback
* type.
* Creates an empty {@link SlicedModel} with the given {@link SliceMetadata} and fallback type.
*
* @param <T>
* @param <T> the payload type.
* @param metadata can be {@literal null}.
* @param fallbackType must not be {@literal null}.
* @param generics must not be {@literal null}.
@@ -160,12 +169,11 @@ public class SlicedModel<T> extends CollectionModel<T> {
}
/**
* Creates an empty {@link SlicedModel} with the given {@link SliceMetadata} and fallback
* type.
* Creates an empty {@link SlicedModel} with the given {@link SliceMetadata} and fallback type.
*
* @param <T>
* @param <T> the payload type.
* @param metadata can be {@literal null}.
* @return
* @return will never be {@literal null}.
* @see #withFallbackType(ParameterizedTypeReference)
*/
public static <T> SlicedModel<T> empty(@Nullable SliceMetadata metadata,
@@ -177,8 +185,7 @@ public class SlicedModel<T> extends CollectionModel<T> {
}
/**
* Creates an empty {@link SlicedModel} with the given {@link SliceMetadata} and fallback
* type.
* Creates an empty {@link SlicedModel} with the given {@link SliceMetadata} and fallback type.
*
* @param <T>
* @param metadata can be {@literal null}.
@@ -208,62 +215,68 @@ public class SlicedModel<T> extends CollectionModel<T> {
/**
* Creates an empty {@link SlicedModel} with the given {@link SliceMetadata} and links.
*
* @param <T>
* @param <T> the payload type.
* @param metadata can be {@literal null}.
* @param links must not be {@literal null}.
* @return
* @return will never be {@literal null}.
*/
public static <T> SlicedModel<T> empty(@Nullable SliceMetadata metadata, Iterable<Link> links) {
return of(Collections.emptyList(), metadata, links);
}
/**
* Creates a new {@link SlicedModel} from the given content, {@link SliceMetadata} and
* {@link Link}s (optional).
* Creates a new {@link SlicedModel} from the given content, {@link SliceMetadata} and {@link Link}s (optional).
*
* @param <T> the payload type.
* @param content must not be {@literal null}.
* @param metadata can be {@literal null}.
* @return will never be {@literal null}.
*/
public static <T> SlicedModel<T> of(Collection<T> content, @Nullable SliceMetadata metadata) {
return new SlicedModel<>(content, metadata);
}
/**
* Creates a new {@link SlicedModel} from the given content, {@link SliceMetadata} and
* {@link Link}s (optional).
* Creates a new {@link SlicedModel} from the given content, {@link SliceMetadata} and {@link Link}s (optional).
*
* @param <T> the payload type.
* @param content must not be {@literal null}.
* @param metadata can be {@literal null}.
* @param links
* @param links must not be {@literal null}.
* @return will never be {@literal null}.
*/
public static <T> SlicedModel<T> of(Collection<T> content, @Nullable SliceMetadata metadata, Link... links) {
return new SlicedModel<>(content, metadata, Arrays.asList(links));
}
/**
* Creates a new {@link SlicedModel} from the given content {@link SliceMetadata} and
* {@link Link}s.
* Creates a new {@link SlicedModel} from the given content {@link SliceMetadata} and {@link Link}s.
*
* @param <T> the payload type.
* @param content must not be {@literal null}.
* @param metadata can be {@literal null}.
* @param links
* @param links must not be {@literal null}.
* @return will never be {@literal null}.
*/
public static <T> SlicedModel<T> of(Collection<T> content, @Nullable SliceMetadata metadata, Iterable<Link> links) {
return new SlicedModel<>(content, metadata, links);
}
/**
* Factory method to easily create a {@link SlicedModel} instance from a set of entities
* and pagination metadata.
* Factory method to easily create a {@link SlicedModel} instance from a set of entities and pagination metadata.
*
* @param <T> the nested {@link EntityModel} type.
* @param <S> the actual payload type.
* @param content must not be {@literal null}.
* @param metadata
* @return
* @return will never be {@literal null}.
*/
@SuppressWarnings("unchecked")
public static <T extends EntityModel<S>, S> SlicedModel<T> wrap(Iterable<S> content, SliceMetadata metadata) {
Assert.notNull(content, "Content must not be null!");
ArrayList<T> resources = new ArrayList<>();
List<T> resources = new ArrayList<>();
for (S element : content) {
resources.add((T) EntityModel.of(element));
@@ -275,18 +288,18 @@ public class SlicedModel<T> extends CollectionModel<T> {
/**
* Returns the pagination metadata.
*
* @return the metadata
* @return the metadata can be {@literal null}.
*/
@JsonProperty("page")
@Nullable
@JsonProperty("page")
public SliceMetadata getMetadata() {
return metadata;
}
/**
* Returns the Link pointing to the next slice (if set).
* Returns the {@link Link} pointing to the next slice (if set).
*
* @return
* @return will never be {@literal null}.
*/
@JsonIgnore
public Optional<Link> getNextLink() {
@@ -294,9 +307,9 @@ public class SlicedModel<T> extends CollectionModel<T> {
}
/**
* Returns the Link pointing to the previous slice (if set).
* Returns the {@link Link} pointing to the previous slice (if set).
*
* @return
* @return will never be {@literal null}.
*/
@JsonIgnore
public Optional<Link> getPreviousLink() {
@@ -336,6 +349,10 @@ public class SlicedModel<T> extends CollectionModel<T> {
return new SlicedModel<>(getContent(), metadata, getLinks(), type);
}
/*
* (non-Javadoc)
* @see org.springframework.hateoas.CollectionModel#toString()
*/
@Override
public String toString() {
return String.format("SlicedModel { content: %s, fallbackType: %s, metadata: %s, links: %s }", //
@@ -344,7 +361,6 @@ public class SlicedModel<T> extends CollectionModel<T> {
/*
* (non-Javadoc)
*
* @see org.springframework.hateoas.CollectionModel#equals(java.lang.Object)
*/
@Override
@@ -380,22 +396,23 @@ public class SlicedModel<T> extends CollectionModel<T> {
* @author Michael Schout
*/
public static class SliceMetadata {
@JsonProperty
@JsonProperty //
private long size;
@JsonProperty
@JsonProperty //
private long number;
protected SliceMetadata() {
}
protected SliceMetadata() {}
/**
* Creates a new {@link SliceMetadata} from the given size, and slice number.
*
* @param size
* @param number zero-indexed slice number
* @param size must be greater or equal to zero.
* @param number zero-indexed slice number, greater or equal to zero.
*/
public SliceMetadata(long size, long number) {
Assert.isTrue(size > -1, "Size must not be negative!");
Assert.isTrue(number > -1, "Number must not be negative!");
@@ -421,6 +438,10 @@ public class SlicedModel<T> extends CollectionModel<T> {
return number;
}
/*
* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return String.format("Metadata: { number: %d, size %d )", number, size);
@@ -428,11 +449,11 @@ public class SlicedModel<T> extends CollectionModel<T> {
/*
* (non-Javadoc)
*
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(@Nullable Object obj) {
if (this == obj) {
return true;
}
@@ -443,21 +464,18 @@ public class SlicedModel<T> extends CollectionModel<T> {
SliceMetadata that = (SliceMetadata) obj;
return this.number == that.number && this.size == that.size;
return super.equals(that) //
&& Objects.equals(this.number, that.number) //
&& Objects.equals(this.size, that.size);
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
int result = 17;
result += 31 * (int) (this.number ^ this.number >>> 32);
result += 31 * (int) (this.size ^ this.size >>> 32);
return result;
return Objects.hash(super.hashCode(), number, size);
}
}
}

35
src/test/java/org/springframework/hateoas/SlicedModelUnitTest.java
View File

@@ -15,8 +15,7 @@
*/
package org.springframework.hateoas;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
import static org.assertj.core.api.Assertions.*;
import java.util.Collections;
@@ -29,8 +28,11 @@ import org.springframework.hateoas.SlicedModel.SliceMetadata;
* Unit tests for SlicedModel
*
* @author Michael Schout
* @author Oliver Drotbohm
* @since 2.1
*/
class SlicedModelUnitTest {
static final SliceMetadata metadata = new SliceMetadata(10, 1);
SlicedModel<Object> resources;
@@ -40,38 +42,41 @@ class SlicedModelUnitTest {
resources = SlicedModel.of(Collections.emptyList(), metadata);
}
@Test
@Test // #1856
void discoversNextLink() {
resources.add(Link.of("foo", IanaLinkRelations.NEXT.value()));
assertThat(resources.getNextLink()).isNotNull();
}
@Test
@Test // #1856
void discoversPreviousLink() {
resources.add(Link.of("custom", IanaLinkRelations.PREV.value()));
assertThat(resources.getPreviousLink()).isNotNull();
}
@Test
@Test // #1856
void preventsNegativeSliceSize() {
assertThatIllegalArgumentException().isThrownBy(() -> {
new SliceMetadata(-1, 0);
});
assertThatIllegalArgumentException()
.isThrownBy(() -> new SliceMetadata(-1, 0));
}
@Test
@Test // #1856
void preventsNegativeSliceNumber() {
assertThatIllegalArgumentException().isThrownBy(() -> {
new SliceMetadata(0, -1);
});
assertThatIllegalArgumentException()
.isThrownBy(() -> new SliceMetadata(0, -1));
}
@Test
@Test // #1856
void exposesElementTypeForEmpty() {
ResolvableType fallbackType = ResolvableType.forClassWithGenerics(EntityModel.class, String.class);
SlicedModel<String> model = SlicedModel.empty(fallbackType);
var fallbackType = ResolvableType.forClassWithGenerics(EntityModel.class, String.class);
var model = SlicedModel.empty(fallbackType);
assertThat(model.getResolvableType().getGeneric(0).resolve()).isEqualTo(EntityModel.class);
}