1 /*
2 * Copyright 2013 smartics, Kronseder & Reiner GmbH
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package de.smartics.resteasy.hypermedia.resources;
17
18 import java.util.List;
19
20 import de.smartics.resteasy.hypermedia.renderer.LinkDescriptor;
21
22 /**
23 * Provides access to discovered resources.
24 */
25 public interface Resources
26 {
27
28 /**
29 * Returns links associated with a given relation.
30 *
31 * @param rel a single relation value.
32 * @return the associated links, may be empty.
33 */
34 List<LinkDescriptor> getLinksForRel(String rel);
35
36 /**
37 * Returns an iterator over the resource links in this repository.
38 *
39 * @return an iterator over the resource links in this repository.
40 */
41 List<LinkDescriptor> links();
42
43 }