1 package org.apache.velocity.util.introspection;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 /**
23 * The introspector cache API definition.
24 *
25 * @author <a href="mailto:henning@apache.org">Henning P. Schmiedehausen</a>
26 * @version $Id: IntrospectorCache.java 476951 2006-11-19 22:22:43Z henning $
27 */
28 public interface IntrospectorCache {
29
30 /**
31 * Clears the internal cache.
32 */
33 void clear();
34
35 /**
36 * Lookup a given Class object in the cache. If it does not exist,
37 * check whether this is due to a class change and purge the caches
38 * eventually.
39 *
40 * @param c The class to look up.
41 * @return A ClassMap object or null if it does not exist in the cache.
42 */
43 ClassMap get(Class c);
44
45 /**
46 * Creates a class map for specific class and registers it in the
47 * cache. Also adds the qualified name to the name->class map
48 * for later Classloader change detection.
49 *
50 * @param c The class for which the class map gets generated.
51 * @return A ClassMap object.
52 */
53 ClassMap put(Class c);
54
55 /**
56 * Register a Cache listener.
57 *
58 * @param listener A Cache listener object.
59 */
60 void addListener(IntrospectorCacheListener listener);
61
62 /**
63 * Remove a Cache listener.
64 *
65 * @param listener A Cache listener object.
66 */
67 void removeListener(IntrospectorCacheListener listener);
68
69 }