KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > hivemind > internal > ExtensionPoint


1 // Copyright 2004, 2005 The Apache Software Foundation
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 package org.apache.hivemind.internal;
16
17 import org.apache.commons.logging.Log;
18 import org.apache.hivemind.ErrorLog;
19 import org.apache.hivemind.Locatable;
20
21 /**
22  * Base interface for service and configuration extension points.
23  *
24  * @author Howard Lewis Ship
25  */
26 public interface ExtensionPoint extends Locatable
27 {
28     /**
29      * Returns the fully qualified id of the extension point.
30      */
31     public String JavaDoc getExtensionPointId();
32
33     /**
34      * Returns the {@link Module} containing the extension point.
35      */
36     public Module getModule();
37
38     /**
39      * Returns true if the extension point is visible to the specified module.
40      *
41      * @param module
42      * The module to check for, may be null (in which case the extension is visible only
43      * if public)
44      * @since 1.1
45      */
46
47     public boolean visibleToModule(Module module);
48
49     /**
50      * Returns the Log instance for this extension point.
51      */
52
53     public Log getLog();
54
55     /**
56      * Returns an {@link org.apache.hivemind.ErrorLog} used to report any recoverable errors related
57      * to the extension point.
58      *
59      * @since 1.1
60      */
61
62     public ErrorLog getErrorLog();
63     
64 }
Popular Tags