#833 - Changed ResourceSupport class name hierarchy.
This commit is contained in:
Oliver Drotbohm
273
src/main/java/org/springframework/hateoas/RepresentationModel.java
Executable file
273
src/main/java/org/springframework/hateoas/RepresentationModel.java
Executable file
@@ -0,0 +1,273 @@
|
||||
/*
|
||||
* Copyright 2012-2019 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.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.springframework.hateoas;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import org.springframework.util.Assert;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonIgnore;
|
||||
import com.fasterxml.jackson.annotation.JsonProperty;
|
||||
|
||||
/**
|
||||
* Base class for DTOs to collect links.
|
||||
*
|
||||
* @author Oliver Gierke
|
||||
* @author Johhny Lim
|
||||
* @author Greg Turnquist
|
||||
*/
|
||||
public class RepresentationModel<T extends RepresentationModel<? extends T>> implements Identifiable<Link> {
|
||||
|
||||
private final List<Link> links;
|
||||
|
||||
public RepresentationModel() {
|
||||
this.links = new ArrayList<>();
|
||||
}
|
||||
|
||||
public RepresentationModel(Link initialLink) {
|
||||
|
||||
Assert.notNull(initialLink, "initialLink must not be null!");
|
||||
|
||||
this.links = new ArrayList<>();
|
||||
this.links.add(initialLink);
|
||||
}
|
||||
|
||||
public RepresentationModel(List<Link> initialLinks) {
|
||||
|
||||
Assert.notNull(initialLinks, "initialLinks must not be null!");
|
||||
|
||||
this.links = new ArrayList<>();
|
||||
this.links.addAll(initialLinks);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the {@link Link} with a rel of {@link IanaLinkRelations#SELF}.
|
||||
*/
|
||||
@JsonIgnore
|
||||
public Optional<Link> getId() {
|
||||
return getLink(IanaLinkRelations.SELF);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds the given link to the resource.
|
||||
*
|
||||
* @param link
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
public T add(Link link) {
|
||||
|
||||
Assert.notNull(link, "Link must not be null!");
|
||||
|
||||
this.links.add(link);
|
||||
|
||||
return (T) this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds all given {@link Link}s to the resource.
|
||||
*
|
||||
* @param links
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
public T add(Iterable<Link> links) {
|
||||
|
||||
Assert.notNull(links, "Given links must not be null!");
|
||||
|
||||
links.forEach(this::add);
|
||||
|
||||
return (T) this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds all given {@link Link}s to the resource.
|
||||
*
|
||||
* @param links must not be {@literal null}.
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
public T add(Link... links) {
|
||||
|
||||
Assert.notNull(links, "Given links must not be null!");
|
||||
|
||||
add(Arrays.asList(links));
|
||||
|
||||
return (T) this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether the resource contains {@link Link}s at all.
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
public boolean hasLinks() {
|
||||
return !this.links.isEmpty();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether the resource contains a {@link Link} with the given rel.
|
||||
*
|
||||
* @param rel
|
||||
* @return
|
||||
*/
|
||||
public boolean hasLink(String rel) {
|
||||
return getLink(rel).isPresent();
|
||||
}
|
||||
|
||||
public boolean hasLink(LinkRelation rel) {
|
||||
return hasLink(rel.value());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns all {@link Link}s contained in this resource.
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
@JsonProperty("links")
|
||||
public Links getLinks() {
|
||||
return Links.of(links);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes all {@link Link}s added to the resource so far.
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
public T removeLinks() {
|
||||
|
||||
this.links.clear();
|
||||
|
||||
return (T) this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the link with the given relation.
|
||||
*
|
||||
* @param relation must not be {@literal null} or empty.
|
||||
* @return the link with the given relation or {@link Optional#empty()} if none found.
|
||||
*/
|
||||
public Optional<Link> getLink(String relation) {
|
||||
return getLink(LinkRelation.of(relation));
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the link with the given {@link LinkRelation}.
|
||||
*
|
||||
* @param relation
|
||||
* @return
|
||||
*/
|
||||
public Optional<Link> getLink(LinkRelation relation) {
|
||||
|
||||
return links.stream() //
|
||||
.filter(it -> it.hasRel(relation)) //
|
||||
.findFirst();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the link with the given relation.
|
||||
*
|
||||
* @param relation must not be {@literal null} or empty.
|
||||
* @return the link with the given relation.
|
||||
* @throws IllegalArgumentException in case no link with the given relation can be found.
|
||||
*/
|
||||
public Link getRequiredLink(String relation) {
|
||||
|
||||
return getLink(relation) //
|
||||
.orElseThrow(() -> new IllegalArgumentException(String.format("No link with rel %s found!", relation)));
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the link with the given relation.
|
||||
*
|
||||
* @param relation must not be {@literal null}.
|
||||
* @return the link with the given relation.
|
||||
* @throws IllegalArgumentException in case no link with the given relation can be found.
|
||||
*/
|
||||
public Link getRequiredLink(LinkRelation relation) {
|
||||
|
||||
Assert.notNull(relation, "Link relation must not be null!");
|
||||
|
||||
return getRequiredLink(relation.value());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns all {@link Link}s with the given relation.
|
||||
*
|
||||
* @param relation must not be {@literal null}.
|
||||
* @return the links in a {@link List}
|
||||
*/
|
||||
public List<Link> getLinks(String relation) {
|
||||
|
||||
Assert.hasText(relation, "Link relation must not be null or empty!");
|
||||
|
||||
return links.stream() //
|
||||
.filter(link -> link.hasRel(relation)) //
|
||||
.collect(Collectors.toList());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns all {@link Link}s with the given relation.
|
||||
*
|
||||
* @param relation must not be {@literal null}.
|
||||
* @return the links in a {@link List}
|
||||
*/
|
||||
public List<Link> getLinks(LinkRelation relation) {
|
||||
|
||||
Assert.notNull(relation, "Link relation must not be null!");
|
||||
|
||||
return getLinks(relation.value());
|
||||
}
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see java.lang.Object#toString()
|
||||
*/
|
||||
@Override
|
||||
public String toString() {
|
||||
return String.format("links: %s", links.toString());
|
||||
}
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see java.lang.Object#equals(java.lang.Object)
|
||||
*/
|
||||
@Override
|
||||
@SuppressWarnings("unchecked")
|
||||
public boolean equals(Object obj) {
|
||||
|
||||
if (this == obj) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (obj == null || !obj.getClass().equals(this.getClass())) {
|
||||
return false;
|
||||
}
|
||||
|
||||
T that = (T) obj;
|
||||
|
||||
return getLinks().equals(that.getLinks());
|
||||
}
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see java.lang.Object#hashCode()
|
||||
*/
|
||||
@Override
|
||||
public int hashCode() {
|
||||
return this.links.hashCode();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user