Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||||
RootDescriptionReciever |
|
| 1.0;1 |
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 | /** |
|
18 | * Extended version of {@link org.apache.tapestry.describe.DescriptionReceiver} |
|
19 | * that adds the ability to describe the root object, and to finish the |
|
20 | * description of an object (allowing the same receiver to be used to describe |
|
21 | * several objects). |
|
22 | * |
|
23 | * @author Howard M. Lewis Ship |
|
24 | */ |
|
25 | public interface RootDescriptionReciever extends DescriptionReceiver |
|
26 | { |
|
27 | ||
28 | /** |
|
29 | * Describes the object, using a {@link DescribableStrategy}, or just the |
|
30 | * object's toString() if there is no strategy for the object. Automatically |
|
31 | * invokes {@link #finishUp()} when done. |
|
32 | * |
|
33 | * @param object |
|
34 | * to be described, which may be null |
|
35 | */ |
|
36 | void describe(Object object); |
|
37 | ||
38 | /** |
|
39 | * Invoked after one object has been fully described. Ends a <table>, |
|
40 | * if one has been started, and resets the receiver to begin a new object. |
|
41 | */ |
|
42 | void finishUp(); |
|
43 | ||
44 | } |