ISpecificationResolverDelegate


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 found by the normal
23   * means. This allows hooks to support specifications from unusual locations, or generated on the
24   * 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       * Invoked by {@link PageSpecificationResolver} to find the indicated page specification.
36       * Returns the specification, or null. The specification, if returned, <em>will be cached</em>
37       * (this represents a change from release 3.0 to release 4.0).
38       * 
39       * @param cycle
40       *            used to gain access to framework and Servlet API objects
41       * @param namespace
42       *            the namespace containing the page
43       * @param simplePageName
44       *            the name of the page (without any namespace prefix)
45       */
46  
47      public IComponentSpecification findPageSpecification(IRequestCycle cycle, INamespace namespace,
48              String   simplePageName);
49  
50      /**
51       * Invoked by {@link PageSpecificationResolver} to find the indicated component specification.
52       * Returns the specification, or null. The specification <em>will be cached</em> (this
53       * represents a change from release 3.0 to release 4.0).
54       * 
55       * @param cycle
56       *            used to gain access to framework and Servlet API objects
57       * @param namespace
58       *            the namespace containing the component
59       * @param type
60       *            the component type (without any namespace prefix)
61       */
62  
63      public IComponentSpecification findComponentSpecification(IRequestCycle cycle,
64              INamespace namespace, String   type);
65  }
66
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags