net.sf.ehcache.pool.sizeof.filter.AnnotationSizeOfFilter Maven / Gradle / Ivy

/**
 *  Copyright 2003-2010 Terracotta, Inc.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package net.sf.ehcache.pool.sizeof.filter;

import net.sf.ehcache.pool.sizeof.annotations.IgnoreSizeOf;
import java.lang.reflect.Field;
import java.util.Collection;
import java.util.Iterator;

/**
 * A Filter that will filter fields, based on the {@link IgnoreSizeOf} annotation
 *
 * @author Chris Dennis
 */
public final class AnnotationSizeOfFilter implements SizeOfFilter {

    /**
     * {@inheritDoc}
     */
    public Collection filterFields(Class klazz, Collection fields) {
        for (Iterator it = fields.iterator(); it.hasNext();) {
            if (it.next().isAnnotationPresent(IgnoreSizeOf.class)) {
                it.remove();
            }
        }
        return fields;
    }

    /**
     * {@inheritDoc}
     */
    public boolean filterClass(Class klazz) {
        boolean classAnnotated = isAnnotationPresentOrInherited(klazz);
        Package pack = klazz.getPackage();
        boolean packageAnnotated = pack == null ? false : pack.isAnnotationPresent(IgnoreSizeOf.class);
        return !classAnnotated && !packageAnnotated;
    }

    private boolean isAnnotationPresentOrInherited(final Class instanceKlazz) {
        Class klazz = instanceKlazz;
        while (klazz != null) {
            final IgnoreSizeOf annotation = klazz.getAnnotation(IgnoreSizeOf.class);
            if (annotation != null) {
                if (klazz == instanceKlazz || annotation.inherited()) {
                    return true;
                }
            }
            klazz = klazz.getSuperclass();
        }
        return false;
    }
}