IComponentClassEnhancer


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.tapestry.spec.IComponentSpecification;
18  
19  /**
20   * A provider of enhanced classes, classes with new methods and new attributes, and possibly,
21   * implementing new Java interfaces. The primary use of class enhancement is to automate the
22   * creation of transient and persistant properties.
23   * <p>
24   * Implementations of this interface must be threadsafe.
25   * 
26   * @author Howard Lewis Ship
27   * @since 3.0
28   * @deprecated To be removed in 4.1
29   * @see org.apache.tapestry.services.ComponentConstructorFactory
30   */
31  
32  public interface IComponentClassEnhancer
33  {
34      /**
35       * Used to access the class for a given component (or page). Returns the specified class, or an
36       * enhanced version of the class if the component requires enhancement.
37       * 
38       * @param specification
39       *            the specification for the component
40       * @param className
41       *            the name of base class to enhance, as extracted from the specification (or
42       *            possibly, from a default).
43       * @throws org.apache.tapestry.ApplicationRuntimeException
44       *             if the class does not exist, is invalid, or may not be enhanced.
45       */
46  
47      public Class   getEnhancedClass(IComponentSpecification specification, String   className);
48  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags