Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
EnforcerRuleHelper |
|
| 1.0;1 |
1 | package org.apache.maven.enforcer.rule.api; | |
2 | ||
3 | /* | |
4 | * Licensed to the Apache Software Foundation (ASF) under one | |
5 | * or more contributor license agreements. See the NOTICE file | |
6 | * distributed with this work for additional information | |
7 | * regarding copyright ownership. The ASF licenses this file | |
8 | * to you under the Apache License, Version 2.0 (the | |
9 | * "License"); you may not use this file except in compliance | |
10 | * with the License. You may obtain a copy of the License at | |
11 | * | |
12 | * http://www.apache.org/licenses/LICENSE-2.0 | |
13 | * | |
14 | * Unless required by applicable law or agreed to in writing, | |
15 | * software distributed under the License is distributed on an | |
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
17 | * KIND, either express or implied. See the License for the | |
18 | * specific language governing permissions and limitations | |
19 | * under the License. | |
20 | */ | |
21 | ||
22 | import java.util.List; | |
23 | import java.util.Map; | |
24 | ||
25 | import org.apache.maven.plugin.logging.Log; | |
26 | import org.codehaus.plexus.PlexusContainer; | |
27 | import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator; | |
28 | import org.codehaus.plexus.component.repository.exception.ComponentLookupException; | |
29 | ||
30 | ||
31 | /** | |
32 | * This is the interface that all helpers will use. This | |
33 | * provides access to the log, session and components to the | |
34 | * rules. | |
35 | * | |
36 | * @author <a href="mailto:brianf@apache.org">Brian Fox</a> | |
37 | * @version $Id: EnforcerRuleHelper.java 805162 2009-08-17 21:48:52Z hboutemy $ | |
38 | */ | |
39 | public interface EnforcerRuleHelper | |
40 | extends ExpressionEvaluator | |
41 | { | |
42 | ||
43 | /** | |
44 | * Gets the log. | |
45 | * | |
46 | * @return the log | |
47 | */ | |
48 | Log getLog (); | |
49 | ||
50 | /* | |
51 | * (non-Javadoc) | |
52 | * | |
53 | * @see org.apache.maven.shared.enforcer.rule.api.EnforcerRuleHelper#getRuntimeInformation() | |
54 | */ | |
55 | /** | |
56 | * Gets the component. | |
57 | * | |
58 | * @param clazz the clazz | |
59 | * | |
60 | * @return the component | |
61 | * | |
62 | * @throws ComponentLookupException the component lookup exception | |
63 | */ | |
64 | Object getComponent ( Class clazz ) | |
65 | throws ComponentLookupException; | |
66 | ||
67 | /** | |
68 | * Gets the component. | |
69 | * | |
70 | * @param componentKey the component key | |
71 | * | |
72 | * @return the component | |
73 | * | |
74 | * @throws ComponentLookupException the component lookup exception | |
75 | */ | |
76 | Object getComponent ( String componentKey ) | |
77 | throws ComponentLookupException; | |
78 | ||
79 | /** | |
80 | * Gets the component. | |
81 | * | |
82 | * @param role the role | |
83 | * @param roleHint the role hint | |
84 | * | |
85 | * @return the component | |
86 | * | |
87 | * @throws ComponentLookupException the component lookup exception | |
88 | */ | |
89 | Object getComponent ( String role, String roleHint ) | |
90 | throws ComponentLookupException; | |
91 | ||
92 | /** | |
93 | * Gets the component map. | |
94 | * | |
95 | * @param role the role | |
96 | * | |
97 | * @return the component map | |
98 | * | |
99 | * @throws ComponentLookupException the component lookup exception | |
100 | */ | |
101 | Map getComponentMap ( String role ) | |
102 | throws ComponentLookupException; | |
103 | ||
104 | /** | |
105 | * Gets the component list. | |
106 | * | |
107 | * @param role the role | |
108 | * | |
109 | * @return the component list | |
110 | * | |
111 | * @throws ComponentLookupException the component lookup exception | |
112 | */ | |
113 | List getComponentList ( String role ) | |
114 | throws ComponentLookupException; | |
115 | ||
116 | /** | |
117 | * Gets the container. | |
118 | * | |
119 | * @return the container | |
120 | */ | |
121 | PlexusContainer getContainer(); | |
122 | } |