1 /***
2 * Copyright 2003-2010 Terracotta, Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package net.sf.ehcache.pool.sizeof.filter;
18
19 import java.lang.reflect.Field;
20 import java.util.Collection;
21
22 /***
23 * Filter to filter types or fields of object graphs passed to a SizeOf engine
24 *
25 * @author Chris Dennis
26 * @see net.sf.ehcache.pool.sizeof.SizeOf
27 */
28 public interface SizeOfFilter {
29
30 /***
31 * Returns the fields to walk and measure for a type
32 * @param klazz the type
33 * @param fields the fields already "qualified"
34 * @return the filtered Set
35 */
36 Collection<Field> filterFields(Class<?> klazz, Collection<Field> fields);
37
38 /***
39 * Checks whether the type needs to be filtered
40 * @param klazz the type
41 * @return true, if to be filtered out
42 */
43 boolean filterClass(Class<?> klazz);
44 }