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 * @author <a href="mailto:cdauth@cdauth.eu">Candid Dauth</a>
27 * @version $Id: IntrospectorCache.java 1329799 2012-04-24 15:41:21Z cbrisson $
28 * @since 1.5
29 */
30 public interface IntrospectorCache {
31
32 /**
33 * Clears the internal cache.
34 */
35 void clear();
36
37 /**
38 * Lookup a given Class object in the cache. If it does not exist,
39 * check whether this is due to a class change and purge the caches
40 * eventually.
41 *
42 * @param c The class to look up.
43 * @return A ClassMap object or null if it does not exist in the cache.
44 */
45 ClassMap get(Class c);
46
47 /**
48 * Lookup a given Class object in the cache. If it does not exist,
49 * check whether this is due to a class change and purge the caches
50 * eventually.
51 *
52 * @param c The class to look up.
53 * @return A ClassFieldMap object or null if it does not exist in the cache.
54 */
55 ClassFieldMap getFieldMap(final Class c);
56
57 /**
58 * Creates a class map for specific class and registers it in the
59 * cache. Also adds the qualified name to the name->class map
60 * for later Classloader change detection.
61 *
62 * @param c The class for which the class map gets generated.
63 * @return A ClassMap object.
64 */
65 ClassMap put(Class c);
66
67 }