FlexPMD/flex-pmd-java/flex-pmd-ruleset-api/src/main/java/com/adobe/ac/pmd/rules/core/IFlexRule.java

/*
 * 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.adobe.ac.pmd.rules.core;

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

import net.sourceforge.pmd.Rule;

import com.adobe.ac.pmd.IFlexViolation;
import com.adobe.ac.pmd.files.IFlexFile;
import com.adobe.ac.pmd.nodes.IPackage;

public interface IFlexRule extends Rule
{
   /**
    * @return ruleName
    */
   String getRuleName();

   /**
    * @param file
    * @param rootNode
    * @param files
    * @return
    */
   List< IFlexViolation > processFile( final IFlexFile file,
                                       final IPackage rootNode,
                                       final Map< String, IFlexFile > files );

   /**
    * @param excludes
    */
   void setExcludes( final Set< String > excludes );
}