FlexPMD/language-module/ruleset/ruleset-flex-basic/src/main/java/org/apache/flex/pmd/rules/parameterized/ParameterizedRegExpBasedRule.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 org.apache.flex.pmd.rules.parameterized;

import net.sourceforge.pmd.lang.rule.properties.StringProperty;
import org.apache.flex.pmd.rules.core.AbstractRegexpBasedRule;
import org.apache.flex.pmd.rules.core.ViolationPriority;

/**
 * @author xagnetti
 */
public class ParameterizedRegExpBasedRule extends AbstractRegexpBasedRule {

    public static StringProperty EXPRESSION_DESCRIPTOR = new StringProperty(
            "expression",
            "expression",
            "",
            1.0f
    );

    public ParameterizedRegExpBasedRule() {
        super();
        definePropertyDescriptor(EXPRESSION_DESCRIPTOR);
    }

    /*
         * (non-Javadoc)
         * @see com.adobe.ac.pmd.rules.core.AbstractFlexRule#getDefaultPriority()
         */
    @Override
    protected ViolationPriority getDefaultPriority() {
        return ViolationPriority.NORMAL;
    }

    /*
     * (non-Javadoc)
     * @see com.adobe.ac.pmd.rules.core.AbstractRegexpBasedRule#getRegexp()
     */
    @Override
    protected String getRegexp() {
        return (String) getProperty(getPropertyDescriptor("expression"));
    }

    /*
     * (non-Javadoc)
     * @see
     * com.adobe.ac.pmd.rules.core.AbstractFlexRule#isConcernedByTheCurrentFile()
     */
    @Override
    protected boolean isConcernedByTheCurrentFile() {
        return true;
    }

    /*
     * (non-Javadoc)
     * @seecom.adobe.ac.pmd.rules.core.AbstractRegexpBasedRule#
     * isViolationDetectedOnThisMatchingLine(java.lang.String)
     */
    @Override
    protected boolean isViolationDetectedOnThisMatchingLine(final String line) {
        return true;
    }

}