org.xwiki.tool.spoon.ForbiddenInvocationProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-tool-spoon Show documentation

Custom processor to use with spoon

There is a newer version: 16.8.0-rc-1

Show newest version

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.tool.spoon;

import java.util.List;
import java.util.Map;

import org.apache.log4j.Level;

import spoon.SpoonException;
import spoon.processing.AbstractProcessor;
import spoon.processing.Property;
import spoon.reflect.code.CtExpression;
import spoon.reflect.code.CtInvocation;

/**
 * Fail the build if some code is calling a forbidden method.
 * 
 * @version $Id: 60f23a977ca7f058fc14d935784c86d3db506266 $
 * @since 9.9RC2
 */
public class ForbiddenInvocationProcessor extends AbstractProcessor>
{
    @Property
    private Map> methods;

    @Override
    public void process(CtInvocation element)
    {
        CtExpression target = element.getTarget();

        if (target != null && target.getType() != null) {
            String type = target.getType().getQualifiedName();
            List methodList = this.methods.get(type);
            if (methodList != null) {
                String method = element.getExecutable().getSimpleName();
                if (methodList.contains(method)) {
                    String message = String.format("Forbidden call to [%s#%s]", type, method);
                    getFactory().getEnvironment().report(this, Level.ERROR, element, message);

                    // Forcing the build to stop
                    throw new SpoonException(message);
                }
            }
        }
    }
}