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 685685 2008-08-13 21:43:27Z nbubna $
27 * @since 1.5
28 */
29 public interface IntrospectorCache {
30
31 /**
32 * Clears the internal cache.
33 */
34 void clear();
35
36 /**
37 * Lookup a given Class object in the cache. If it does not exist,
38 * check whether this is due to a class change and purge the caches
39 * eventually.
40 *
41 * @param c The class to look up.
42 * @return A ClassMap object or null if it does not exist in the cache.
43 */
44 ClassMap get(Class c);
45
46 /**
47 * Creates a class map for specific class and registers it in the
48 * cache. Also adds the qualified name to the name->class map
49 * for later Classloader change detection.
50 *
51 * @param c The class for which the class map gets generated.
52 * @return A ClassMap object.
53 */
54 ClassMap put(Class c);
55
56 }