← Back to branch summary

~ubuntu-branches/ubuntu/utopic/maven-enforcer/utopic

« back to all changes in this revision

Viewing changes to enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleHelper.java

  • Committer: Package Import Robot
  • Author(s): Torsten Werner
  • Date: 2011-09-12 22:30:16 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: package-import@ubuntu.com-20110912223016-e2pk04avoq8bur7t
Tags: 1.0-1
* Team upload
* New upstream release.
* Add more Build-Depends.

Show diffs side-by-side

added added

removed removed

Lines of Context:
enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerRuleHelper.java
 
1
package org.apache.maven.enforcer.rule.api;
 
2
 
1
3
/*
2
4
 * Licensed to the Apache Software Foundation (ASF) under one
3
5
 * or more contributor license agreements.  See the NOTICE file
16
18
 * specific language governing permissions and limitations
17
19
 * under the License.
18
20
 */
19
 
package org.apache.maven.enforcer.rule.api;
20
21
 
21
22
import java.util.List;
22
23
import java.util.Map;
31
32
 * This is the interface that all helpers will use. This
32
33
 * provides access to the log, session and components to the
33
34
 * rules.
34
 
 * 
 
35
 *
35
36
 * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
36
 
 * @version $Id: EnforcerRuleHelper.java 675992 2008-07-11 15:42:48Z hboutemy $
 
37
 * @version $Id: EnforcerRuleHelper.java 805162 2009-08-17 21:48:52Z hboutemy $
37
38
 */
38
39
public interface EnforcerRuleHelper
39
40
    extends ExpressionEvaluator
41
42
 
42
43
    /**
43
44
     * Gets the log.
44
 
     * 
 
45
     *
45
46
     * @return the log
46
47
     */
47
 
    public Log getLog ();
 
48
    Log getLog ();
48
49
 
49
50
    /*
50
51
     * (non-Javadoc)
51
 
     * 
 
52
     *
52
53
     * @see org.apache.maven.shared.enforcer.rule.api.EnforcerRuleHelper#getRuntimeInformation()
53
54
     */
54
55
    /**
55
56
     * Gets the component.
56
 
     * 
 
57
     *
57
58
     * @param clazz the clazz
58
 
     * 
 
59
     *
59
60
     * @return the component
60
 
     * 
 
61
     *
61
62
     * @throws ComponentLookupException the component lookup exception
62
63
     */
63
 
    public Object getComponent ( Class clazz )
 
64
    Object getComponent ( Class clazz )
64
65
        throws ComponentLookupException;
65
66
 
66
67
    /**
67
68
     * Gets the component.
68
 
     * 
 
69
     *
69
70
     * @param componentKey the component key
70
 
     * 
 
71
     *
71
72
     * @return the component
72
 
     * 
 
73
     *
73
74
     * @throws ComponentLookupException the component lookup exception
74
75
     */
75
 
    public Object getComponent ( String componentKey )
 
76
    Object getComponent ( String componentKey )
76
77
        throws ComponentLookupException;
77
78
 
78
79
    /**
79
80
     * Gets the component.
80
 
     * 
 
81
     *
81
82
     * @param role the role
82
83
     * @param roleHint the role hint
83
 
     * 
 
84
     *
84
85
     * @return the component
85
 
     * 
 
86
     *
86
87
     * @throws ComponentLookupException the component lookup exception
87
88
     */
88
 
    public Object getComponent ( String role, String roleHint )
 
89
    Object getComponent ( String role, String roleHint )
89
90
        throws ComponentLookupException;
90
91
 
91
92
    /**
92
93
     * Gets the component map.
93
 
     * 
 
94
     *
94
95
     * @param role the role
95
 
     * 
 
96
     *
96
97
     * @return the component map
97
 
     * 
 
98
     *
98
99
     * @throws ComponentLookupException the component lookup exception
99
100
     */
100
 
    public Map getComponentMap ( String role )
 
101
    Map getComponentMap ( String role )
101
102
        throws ComponentLookupException;
102
103
 
103
104
    /**
104
105
     * Gets the component list.
105
 
     * 
 
106
     *
106
107
     * @param role the role
107
 
     * 
 
108
     *
108
109
     * @return the component list
109
 
     * 
 
110
     *
110
111
     * @throws ComponentLookupException the component lookup exception
111
112
     */
112
 
    public List getComponentList ( String role )
 
113
    List getComponentList ( String role )
113
114
        throws ComponentLookupException;
114
115
 
115
116
    /**
116
117
     * Gets the container.
117
 
     * 
 
118
     *
118
119
     * @return the container
119
120
     */
120
 
    public PlexusContainer getContainer(); 
 
121
    PlexusContainer getContainer();
121
122
}