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

#31 - Introduced LinkDiscoverer to extract Link instances from representations.

Browse Source 
LinkDiscoverer exposes an API to find Links by their relation types in representations. Added JSONPath based base class and a DefaultLinkDiscoverer that finds Links based on the default rendering of our Jackson mappings.
This commit is contained in:
Oliver Gierke
2012-12-15 18:29:26 +01:00
parent f3ab76cfd2
commit 0e0bf16957
7 changed files with 363 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
src/main/java/org/springframework/hateoas/LinkDiscoverer.java Normal file
View File

@@ -0,0 +1,63 @@
/*
* Copyright 2012 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.io.InputStream;
import java.util.List;
/**
* Interface to allow discovering links by relation type from some source.
*
* @author Oliver Gierke
*/
public interface LinkDiscoverer {
/**
* Finds a single link with the given relation type in the given {@link String} representation.
*
* @param rel must not be {@literal null} or empty.
* @param representation must not be {@literal null} or empty.
* @return the first link with the given relation type found, or {@literal null} if none was found.
*/
Link findLinkWithRel(String rel, String representation);
/**
* Finds a single link with the given relation type in the given {@link InputStream} representation.
*
* @param rel must not be {@literal null} or empty.
* @param representation must not be {@literal null} or empty.
* @return the first link with the given relation type found, or {@literal null} if none was found.
*/
Link findLinkWithRel(String rel, InputStream representation);
/**
* Returns all links with the given relation type found in the given {@link String} representation.
*
* @param rel must not be {@literal null} or empty.
* @param representation must not be {@literal null} or empty.
* @return
*/
List<Link> findLinksWithRel(String rel, String representation);
/**
* Returns all links with the given relation type found in the given {@link InputStream} representation.
*
* @param rel must not be {@literal null} or empty.
* @param representation must not be {@literal null} or empty.
* @return
*/
List<Link> findLinksWithRel(String rel, InputStream representation);
}