1 /*
2 * Copyright 2006-2012 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.maven.util.report.link;
17
18
19 /**
20 * Defines the API to a strategy to handle information to construct a link.
21 */
22 public interface LinkConstructorStrategy
23 {
24 // ********************************* Fields *********************************
25
26 // --- constants ------------------------------------------------------------
27
28 // ****************************** Initializer *******************************
29
30 // ****************************** Inner Classes *****************************
31
32 // ********************************* Methods ********************************
33
34 // --- get&set --------------------------------------------------------------
35
36 /**
37 * Returns the configuration of this strategy instance.
38 *
39 * @return the configuration of this strategy instance.
40 */
41 LinkConstructorStrategyConfig getConfig();
42
43 // --- business -------------------------------------------------------------
44
45 /**
46 * Constructs a link to the specified Java element.
47 *
48 * @return the link to the element.
49 */
50 String constructLink(String basePath, JavaElementRef ref);
51
52 // --- object basics --------------------------------------------------------
53
54 }