org.apache.bval.jsr.xml.AnnotationIgnores Maven / Gradle / Ivy

Go to download
/*
 * 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 org.apache.bval.jsr.xml;

import java.lang.reflect.Field;
import java.lang.reflect.Member;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Description: This class instantiated during the parsing of the XML configuration
 * data and keeps track of the annotations which should be ignored.

 */
public final class AnnotationIgnores {

    private static final Logger log = Logger.getLogger(AnnotationIgnores.class.getName());

    /**
     * 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, Boolean> ignoreAnnotationDefaults = new HashMap, 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
     * true in the configuration
     * for this class.
     */
    private final Map, Map> ignoreAnnotationOnMember =
        new HashMap, Map>();

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

    private final Map, Map>> ignoreAnnotationOnParameter =
        new HashMap, Map>>();
    private final Map ignoreAnnotationOnReturn = new HashMap();
    private final Map ignoreAnnotationOnCrossParameter = new HashMap();

    /**
     * Record the ignore state for a particular annotation type.
     * @param clazz
     * @param b, default true if null
     */
    public void setDefaultIgnoreAnnotation(Class clazz, Boolean b) {
        ignoreAnnotationDefaults.put(clazz, b == null || b.booleanValue());
    }

    /**
     * Learn whether the specified annotation type should be ignored.
     * @param clazz
     * @return boolean
     */
    public boolean getDefaultIgnoreAnnotation(Class clazz) {
        return ignoreAnnotationDefaults.containsKey(clazz) && ignoreAnnotationDefaults.get(clazz);
    }

    /**
     * Ignore annotations on a particular {@link Member} of a class.
     * @param member
     */
    public void setIgnoreAnnotationsOnMember(Member member, boolean value) {
        Class beanClass = member.getDeclaringClass();
        Map memberList = ignoreAnnotationOnMember.get(beanClass);
        if (memberList == null) {
            memberList = new HashMap();
            ignoreAnnotationOnMember.put(beanClass, memberList);
        }
        memberList.put(member, value);
    }

    /**
     * Learn whether annotations should be ignored on a particular {@link Member} of a class.
     * @param member
     * @return boolean
     */
    public boolean isIgnoreAnnotations(final Member member) {
        final Class clazz = member.getDeclaringClass();
        final Map ignoreAnnotationForMembers = ignoreAnnotationOnMember.get(clazz);
        if (ignoreAnnotationForMembers != null && ignoreAnnotationForMembers.containsKey(member)) {
            final boolean value = ignoreAnnotationForMembers.get(member);
            if (value) {
                logMessage(member, clazz);
            }
            return value;
        }

        final boolean ignoreAnnotation = getDefaultIgnoreAnnotation(clazz);
        if (ignoreAnnotation) {
            logMessage(member, clazz);
        }
        return ignoreAnnotation;
    }

    public void setIgnoreAnnotationsOnParameter(final Member method, final int i, final boolean value) {
        final Class beanClass = method.getDeclaringClass();
        Map> memberList = ignoreAnnotationOnParameter.get(beanClass);
        if (memberList == null) {
            memberList = new HashMap>();
            ignoreAnnotationOnParameter.put(beanClass, memberList);
        }
        Map indexes = memberList.get(method);
        if (indexes == null) {
            indexes = new HashMap();
            memberList.put(method, indexes);
        }
        indexes.put(i, value);
    }

    public boolean isIgnoreAnnotationOnParameter(final Member m, final int i) {
        final Map> members = ignoreAnnotationOnParameter.get(m.getDeclaringClass());
        if (members != null) {
            final Map indexes = members.get(m);
            if (indexes != null && indexes.containsKey(i)) {
                return indexes.get(i);
            }
        }
        return false;
    }

    private void logMessage(Member member, Class clazz) {
        String type;
        if (member instanceof Field) {
            type = "Field";
        } else {
            type = "Property";
        }
        log.log(Level.FINEST, String.format("%s level annotations are getting ignored for %s.%s", type, clazz.getName(),
            member.getName()));
    }

    /**
     * Record the ignore state of a particular class. 
     * @param clazz
     * @param b
     */
    public void setIgnoreAnnotationsOnClass(Class clazz, boolean b) {
        ignoreAnnotationOnClass.put(clazz, b);
    }

    /**
     * Learn whether annotations should be ignored for a given class.
     * @param clazz to check
     * @return boolean
     */
    public boolean isIgnoreAnnotations(Class clazz) {
        boolean ignoreAnnotation;
        if (ignoreAnnotationOnClass.containsKey(clazz)) {
            ignoreAnnotation = ignoreAnnotationOnClass.get(clazz);
        } else {
            ignoreAnnotation = getDefaultIgnoreAnnotation(clazz);
        }
        if (ignoreAnnotation) {
            log.log(Level.FINEST, String.format("Class level annotation are getting ignored for %s", clazz.getName()));
        }
        return ignoreAnnotation;
    }

    public void setIgnoreAnnotationOnReturn(final Member method, final boolean value) {
        ignoreAnnotationOnReturn.put(method, value);
    }

    public boolean isIgnoreAnnotationOnReturn(final Member m) {
        final Boolean value = ignoreAnnotationOnReturn.get(m);
        if (value != null) {
            return value;
        }
        return false;
    }

    public void setIgnoreAnnotationOnCrossParameter(final Member method, final boolean value) {
        ignoreAnnotationOnCrossParameter.put(method, value);
    }

    public boolean isIgnoreAnnotationOnCrossParameter(final Member m) {
        final Boolean value = ignoreAnnotationOnCrossParameter.get(m);
        if (value != null) {
            return value;
        }
        return false;
    }
}