Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ISpecificationSource |
|
| 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.engine; | |
16 | ||
17 | import org.apache.hivemind.Resource; | |
18 | import org.apache.tapestry.INamespace; | |
19 | import org.apache.tapestry.spec.IComponentSpecification; | |
20 | import org.apache.tapestry.spec.ILibrarySpecification; | |
21 | ||
22 | /** | |
23 | * Defines access to component specifications. | |
24 | * | |
25 | * @see IComponentSpecification | |
26 | * @author Howard Lewis Ship | |
27 | */ | |
28 | ||
29 | public interface ISpecificationSource | |
30 | { | |
31 | ||
32 | /** | |
33 | * Retrieves a component specification, parsing it as necessary. | |
34 | * | |
35 | * @param specificationLocation | |
36 | * the location where the specification may be read from. | |
37 | * @throws org.apache.hivemind.ApplicationRuntimeException | |
38 | * if the specification doesn't exist, is unreadable or invalid. | |
39 | * @since 2.2 | |
40 | */ | |
41 | ||
42 | IComponentSpecification getComponentSpecification( | |
43 | Resource specificationLocation); | |
44 | ||
45 | /** | |
46 | * Retrieves a page specification, parsing it as necessary. | |
47 | * | |
48 | * @param specificationLocation | |
49 | * the location where the specification may be read from. | |
50 | * @throws org.apache.hivemind.ApplicationRuntimeException | |
51 | * if the specification doesn't exist, is unreadable or invalid. | |
52 | * @since 2.2 | |
53 | */ | |
54 | ||
55 | IComponentSpecification getPageSpecification( | |
56 | Resource specificationLocation); | |
57 | ||
58 | /** | |
59 | * Returns a {@link org.apache.tapestry.spec.LibrarySpecification} with the | |
60 | * given path. | |
61 | * | |
62 | * @param specificationLocation | |
63 | * the resource path of the specification to return | |
64 | * @throws org.apache.hivemind.ApplicationRuntimeException | |
65 | * if the specification cannot be read | |
66 | * @since 2.2 | |
67 | */ | |
68 | ||
69 | ILibrarySpecification getLibrarySpecification( | |
70 | Resource specificationLocation); | |
71 | ||
72 | /** | |
73 | * Returns the {@link INamespace} for the application. | |
74 | * | |
75 | * @since 2.2 | |
76 | */ | |
77 | ||
78 | INamespace getApplicationNamespace(); | |
79 | ||
80 | /** | |
81 | * Returns the {@link INamespace} for the framework itself. | |
82 | * | |
83 | * @since 2.2 | |
84 | */ | |
85 | ||
86 | INamespace getFrameworkNamespace(); | |
87 | } |