Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||||
ISpecificationResolverDelegate |
|
| 1.0;1 |
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.tapestry.resolver; |
|
16 | ||
17 | import org.apache.tapestry.INamespace; |
|
18 | import org.apache.tapestry.IRequestCycle; |
|
19 | import org.apache.tapestry.spec.IComponentSpecification; |
|
20 | ||
21 | /** |
|
22 | * Delegate interface used when a page or component specification can not be |
|
23 | * found by the normal means. This allows hooks to support specifications from |
|
24 | * unusual locations, or generated on the fly. |
|
25 | * <p> |
|
26 | * The delegate must be coded in a threadsafe manner. |
|
27 | * |
|
28 | * @author Howard Lewis Ship |
|
29 | * @since 3.0 |
|
30 | */ |
|
31 | ||
32 | public interface ISpecificationResolverDelegate |
|
33 | { |
|
34 | ||
35 | /** |
|
36 | * Invoked by {@link PageSpecificationResolver} to find the indicated page |
|
37 | * specification. Returns the specification, or null. The specification, if |
|
38 | * returned, <em>will be cached</em> (this represents a change from |
|
39 | * release 3.0 to release 4.0). |
|
40 | * |
|
41 | * @param cycle |
|
42 | * used to gain access to framework and Servlet API objects |
|
43 | * @param namespace |
|
44 | * the namespace containing the page |
|
45 | * @param simplePageName |
|
46 | * the name of the page (without any namespace prefix) |
|
47 | */ |
|
48 | ||
49 | IComponentSpecification findPageSpecification(IRequestCycle cycle, |
|
50 | INamespace namespace, String simplePageName); |
|
51 | ||
52 | /** |
|
53 | * Invoked by {@link PageSpecificationResolver} to find the indicated |
|
54 | * component specification. Returns the specification, or null. The |
|
55 | * specification <em>will be cached</em> (this represents a change from |
|
56 | * release 3.0 to release 4.0). |
|
57 | * |
|
58 | * @param cycle |
|
59 | * used to gain access to framework and Servlet API objects |
|
60 | * @param namespace |
|
61 | * the namespace containing the component |
|
62 | * @param type |
|
63 | * the component type (without any namespace prefix) |
|
64 | */ |
|
65 | ||
66 | IComponentSpecification findComponentSpecification( |
|
67 | IRequestCycle cycle, INamespace namespace, String type); |
|
68 | } |