com.agimatec.validation.jsr303.xml.AnnotationIgnores.java Source code

Introduction

Here is the source code for com.agimatec.validation.jsr303.xml.AnnotationIgnores.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 com.agimatec.validation.jsr303.xml;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import java.lang.reflect.Field;
import java.lang.reflect.Member;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Description: This class instantiated during the parsing of the XML configuration
 * data and keeps track of the annotations which should be ignored.<br/>
 * User: roman <br/>
 * Date: 26.11.2009 <br/>
 * Time: 13:09:21 <br/>
 * Copyright: Agimatec GmbH
 */
public final class AnnotationIgnores {

    private static final Log log = LogFactory.getLog(AnnotationIgnores.class);

    /**
     * Keeps track whether the 'ignore-annotations' flag is set on bean level in the
     * xml configuration. 
     * If 'ignore-annotations' is not specified: default = true
     */
    private final Map<Class<?>, Boolean> ignoreAnnotationDefaults = new HashMap<Class<?>, Boolean>();

    /**
     * Keeps track of explicitly excluded members (fields and properties) for a given class.
     * If a member appears in
     * the list mapped to a given class 'ignore-annotations' was explicitly set to
     * <code>true</code> in the configuration
     * for this class.
     */
    private final Map<Class<?>, List<Member>> ignoreAnnotationOnMember = new HashMap<Class<?>, List<Member>>();

    private final Map<Class<?>, Boolean> ignoreAnnotationOnClass = new HashMap<Class<?>, Boolean>();

    public void setDefaultIgnoreAnnotation(Class<?> clazz, Boolean b) {
        if (b == null) {
            ignoreAnnotationDefaults.put(clazz, Boolean.TRUE);
        } else {
            ignoreAnnotationDefaults.put(clazz, b);
        }
    }

    public boolean getDefaultIgnoreAnnotation(Class<?> clazz) {
        return ignoreAnnotationDefaults.containsKey(clazz) && ignoreAnnotationDefaults.get(clazz);
    }

    public void setIgnoreAnnotationsOnMember(Member member) {
        Class<?> beanClass = member.getDeclaringClass();
        if (ignoreAnnotationOnMember.get(beanClass) == null) {
            List<Member> tmpList = new ArrayList<Member>();
            tmpList.add(member);
            ignoreAnnotationOnMember.put(beanClass, tmpList);
        } else {
            ignoreAnnotationOnMember.get(beanClass).add(member);
        }
    }

    public boolean isIgnoreAnnotations(Member member) {
        boolean ignoreAnnotation;
        Class<?> clazz = member.getDeclaringClass();
        List<Member> ignoreAnnotationForMembers = ignoreAnnotationOnMember.get(clazz);
        if (ignoreAnnotationForMembers == null || !ignoreAnnotationForMembers.contains(member)) {
            ignoreAnnotation = getDefaultIgnoreAnnotation(clazz);
        } else {
            ignoreAnnotation = ignoreAnnotationForMembers.contains(member);
        }
        if (ignoreAnnotation) {
            logMessage(member, clazz);
        }
        return ignoreAnnotation;
    }

    private void logMessage(Member member, Class<?> clazz) {
        String type;
        if (member instanceof Field) {
            type = "Field";
        } else {
            type = "Property";
        }
        log.debug(type + " level annotations are getting ignored for " + clazz.getName() + "." + member.getName());
    }

    public void setIgnoreAnnotationsOnClass(Class<?> clazz, boolean b) {
        ignoreAnnotationOnClass.put(clazz, b);
    }

    public boolean isIgnoreAnnotations(Class<?> clazz) {
        boolean ignoreAnnotation;
        if (ignoreAnnotationOnClass.containsKey(clazz)) {
            ignoreAnnotation = ignoreAnnotationOnClass.get(clazz);
        } else {
            ignoreAnnotation = getDefaultIgnoreAnnotation(clazz);
        }
        if (log.isDebugEnabled() && ignoreAnnotation) {
            log.debug("Class level annotation are getting ignored for " + clazz.getName());
        }
        return ignoreAnnotation;
    }
}