|
|||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
ReportStatusHub.java | - | - | - | - |
|
1 | // Copyright 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.tapestry.describe; | |
16 | ||
17 | import org.apache.tapestry.IMarkupWriter; | |
18 | import org.apache.tapestry.event.ReportStatusListener; | |
19 | ||
20 | /** | |
21 | * Service for collecting together status information across the framework; service implementations | |
22 | * implement the {@link org.apache.tapestry.event.ReportStatusListener} interface and register | |
23 | * themselves as listeners here. When desired, the {@link #fireReportStatus(IMarkupWriter)} event | |
24 | * will invoke the listener method on each registered object. | |
25 | * | |
26 | * @author Howard M. Lewis Ship | |
27 | * @since 4.0 | |
28 | */ | |
29 | public interface ReportStatusHub | |
30 | { | |
31 | /** | |
32 | * Adds the listener; listeners will be invoked in the order in which they are added. | |
33 | * <strong>Note: only service implementation that are singletons should be report status | |
34 | * listeners. Threaded or pooled implementations should not be added; or should be careful to | |
35 | * add and remove themselves from the hub directly.</strong> | |
36 | * | |
37 | * @param listener | |
38 | */ | |
39 | public void addReportStatusListener(ReportStatusListener listener); | |
40 | ||
41 | public void removeReportStatusListener(ReportStatusListener listener); | |
42 | ||
43 | /** | |
44 | * Generates an HTML status report by invoking | |
45 | * {@link ReportStatusListener#reportStatus(ReportStatusEvent)} on each registered listener. | |
46 | * | |
47 | * @param writer | |
48 | * a markup writer to send the report to. | |
49 | */ | |
50 | public void fireReportStatus(IMarkupWriter writer); | |
51 | } |
|