net.sf.eclipsecs.core.projectconfig.FileMatchPattern.java Source code

Introduction

Here is the source code for net.sf.eclipsecs.core.projectconfig.FileMatchPattern.java

Source

//============================================================================
//
// Copyright (C) 2002-2014  David Schneider, Lars Kdderitzsch
//
// This library 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 library 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 library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//============================================================================

package net.sf.eclipsecs.core.projectconfig;

import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;

import net.sf.eclipsecs.core.Messages;
import net.sf.eclipsecs.core.util.CheckstylePluginException;

import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.apache.commons.lang.builder.ToStringBuilder;
import org.apache.commons.lang.builder.ToStringStyle;

/**
 * A file match pattern is a pattern used in a regular express to check for
 * matching file names.
 */
public class FileMatchPattern implements Cloneable {

    private boolean mIsIncludePattern = true;

    private Pattern mRegexPattern;

    private String mPatternString;

    /**
     * Construct a new <code>FileMatchPattern</code>.
     * 
     * @param pattern The new pattern.
     * @throws CheckstylePluginException Error during processing
     */
    public FileMatchPattern(String pattern) throws CheckstylePluginException {
        setMatchPattern(pattern);
    }

    /**
     * Returns the match pattern.
     * 
     * @return String
     */
    public String getMatchPattern() {
        return mRegexPattern.pattern();
    }

    /**
     * Sets the match pattern.
     * 
     * @param pattern The match pattern to set
     * @throws CheckstylePluginException Error during processing
     */
    public void setMatchPattern(String pattern) throws CheckstylePluginException {
        if ((pattern == null) || (pattern.trim().length() == 0)) {
            throw new CheckstylePluginException(Messages.errorEmptyPattern);
        }
        try {
            mRegexPattern = Pattern.compile(pattern);
            mPatternString = pattern;
        } catch (PatternSyntaxException e) {
            CheckstylePluginException.rethrow(e); // wrap the exception
        }
    }

    /**
     * Tests a file name to see if it matches the pattern.
     * 
     * @param fileName File name to be tested.
     * @return <code>true</code>= match, <code>false</code>= no match.
     */
    public boolean isMatch(String fileName) {
        boolean result = false;

        Matcher matcher = mRegexPattern.matcher(fileName);
        result = matcher.find();

        return result;
    }

    /**
     * Returns the isIncludePattern.
     * 
     * @return boolean
     */
    public boolean isIncludePattern() {
        return mIsIncludePattern;
    }

    /**
     * Sets the isIncludePattern.
     * 
     * @param isIncludePattern The isIncludePattern to set
     */
    public void setIsIncludePattern(boolean isIncludePattern) {
        mIsIncludePattern = isIncludePattern;
    }

    /**
     * Clone the object.
     * 
     * @return The clone
     */
    public FileMatchPattern clone() {
        try {
            return (FileMatchPattern) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new InternalError(); // should never happen
        }
    }

    /**
     * {@inheritDoc}
     */
    public boolean equals(Object obj) {
        if (obj == null || !(obj instanceof FileMatchPattern)) {
            return false;
        }
        if (this == obj) {
            return true;
        }

        FileMatchPattern rhs = (FileMatchPattern) obj;
        return new EqualsBuilder().append(mIsIncludePattern, rhs.mIsIncludePattern)
                .append(mPatternString, rhs.mPatternString).isEquals();
    }

    /**
     * {@inheritDoc}
     */
    public int hashCode() {
        return new HashCodeBuilder(7687, 1000003).append(mIsIncludePattern).append(mPatternString).toHashCode();
    }

    /**
     * {@inheritDoc}
     */
    public String toString() {
        return ToStringBuilder.reflectionToString(this, ToStringStyle.MULTI_LINE_STYLE);
    }
}