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

#41, #42 - Allow ResourceAssemberSupport to be used without Identifiable.

Browse Source 
Extracted Identifiable related code into an IdentifiableResourceAssemblerSupport to be able to use ResourceAssemblerSupport without the need of the domain object to implement Identifiable.
This commit is contained in:
Alex Coyle
2013-01-21 13:02:48 +00:00
committed by Oliver Gierke
parent 3f8b90e2b5
commit 6b7256edad
3 changed files with 104 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
src/main/java/org/springframework/hateoas/mvc/IdentifiableResourceAssemblerSupport.java Normal file
View File

@@ -0,0 +1,93 @@
/*
* Copyright 2012-2013 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.mvc;
import static org.springframework.hateoas.mvc.ControllerLinkBuilder.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.springframework.hateoas.Identifiable;
import org.springframework.hateoas.ResourceAssembler;
import org.springframework.hateoas.ResourceSupport;
import org.springframework.util.Assert;
/**
* Base class to implement {@link ResourceAssembler}s. Will automate {@link ResourceSupport} instance creation and make
* sure a self-link is always added.
*
* @author Oliver Gierke
*/
public abstract class IdentifiableResourceAssemblerSupport<T extends Identifiable<?>, D extends ResourceSupport>
extends ResourceAssemblerSupport<T, D> {
private final Class<?> controllerClass;
/**
* Creates a new {@link ResourceAssemblerSupport} using the given controller class and resource type.
*
* @param controllerClass must not be {@literal null}.
* @param resourceType must not be {@literal null}.
*/
public IdentifiableResourceAssemblerSupport(Class<?> controllerClass, Class<D> resourceType) {
super(controllerClass, resourceType);
this.controllerClass = controllerClass;
}
/**
* Creates a new resource and adds a self link to it consisting using the {@link Identifiable}'s id.
*
* @param entity must not be {@literal null}.
* @return
*/
protected D createResource(T entity) {
return createResource(entity, new Object[0]);
}
protected D createResource(T entity, Object... parameters) {
return createResourceWithId(entity.getId(), entity, parameters);
}
@Override
protected D createResourceWithId(Object id, T entity, Object... parameters) {
Assert.notNull(entity);
Assert.notNull(id);
D instance = instantiateResource(entity);
instance.add(linkTo(controllerClass, unwrapIdentifyables(parameters)).slash(id).withSelfRel());
return instance;
}
/**
* Extracts the ids of the given values in case they're {@link Identifiable}s. Returns all other objects as they are.
*
* @param values must not be {@literal null}.
* @return
*/
private Object[] unwrapIdentifyables(Object[] values) {
List<Object> result = new ArrayList<Object>(values.length);
for (Object element : Arrays.asList(values)) {
result.add(element instanceof Identifiable ? ((Identifiable<?>) element).getId() : element);
}
return result.toArray();
}
}

50
src/main/java/org/springframework/hateoas/mvc/ResourceAssemblerSupport.java
View File

@@ -1,13 +1,13 @@
/*
* Copyright 2012 the original author or authors.
* Copyright 2012-2013 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 coimport javax.xml.bind.annotation.XmlNs;
import javax.xml.bind.annotation.XmlSchema;
eed to in writing, software
* 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
@@ -18,11 +18,9 @@ package org.springframework.hateoas.mvc;
import static org.springframework.hateoas.mvc.ControllerLinkBuilder.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.springframework.beans.BeanUtils;
import org.springframework.hateoas.Identifiable;
import org.springframework.hateoas.ResourceAssembler;
import org.springframework.hateoas.ResourceSupport;
import org.springframework.util.Assert;
@@ -33,8 +31,7 @@ import org.springframework.util.Assert;
*
* @author Oliver Gierke
*/
public abstract class ResourceAssemblerSupport<T extends Identifiable<?>, D extends ResourceSupport> implements
ResourceAssembler<T, D> {
public abstract class ResourceAssemblerSupport<T, D extends ResourceSupport> implements ResourceAssembler<T, D> {
private final Class<?> controllerClass;
private final Class<D> resourceType;
@@ -73,20 +70,6 @@ public abstract class ResourceAssemblerSupport<T extends Identifiable<?>, D exte
return result;
}
/**
* Creates a new resource and adds a self link to it consisting using the {@link Identifiable}'s id.
*
* @param entity must not be {@literal null}.
* @return
*/
protected D createResource(T entity) {
return createResource(entity, new Object[0]);
}
protected D createResource(T entity, Object... parameters) {
return createResourceWithId(entity.getId(), entity, parameters);
}
/**
* Creates a new resource with a self link to the given id.
*
@@ -104,27 +87,10 @@ public abstract class ResourceAssemblerSupport<T extends Identifiable<?>, D exte
Assert.notNull(id);
D instance = instantiateResource(entity);
instance.add(linkTo(controllerClass, unwrapIdentifyables(parameters)).slash(id).withSelfRel());
instance.add(linkTo(controllerClass, parameters).slash(id).withSelfRel());
return instance;
}
/**
* Extracts the ids of the given values in case they're {@link Identifiable}s. Returns all other objects as they are.
*
* @param values must not be {@literal null}.
* @return
*/
private Object[] unwrapIdentifyables(Object[] values) {
List<Object> result = new ArrayList<Object>(values.length);
for (Object element : Arrays.asList(values)) {
result.add((element instanceof Identifiable) ? ((Identifiable<?>) element).getId() : element);
}
return result.toArray();
}
/**
* Instantiates the resource object. Default implementation will assume a no-arg constructor and use reflection but
* can be overridden to manually set up the object instance initially (e.g. to improve performance if this becomes an