/*
 * NOTE: This copyright does *not* cover user programs that use HQ
 * program services by normal system calls through the application
 * program interfaces provided as part of the Hyperic Plug-in Development
 * Kit or the Hyperic Client Development Kit - this is merely considered
 * normal use of the program, and does *not* fall under the heading of
 * "derived work".
 * 
 * Copyright (C) [2004, 2005, 2006], Hyperic, Inc.
 * This file is part of HQ.
 * 
 * HQ is free software; you can redistribute it and/or modify
 * it under the terms version 2 of the GNU General Public License as
 * published by the Free Software Foundation. This program 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 General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA.
 */

package org.hyperic.util.file.match;

import java.io.File;
import org.apache.tools.ant.BuildException;

/**
 * This exception is thrown by the MatcherScanner class when
 * it detects multiple matchselectors have matched a single path.
 * This will only be thrown if the matchconfig had its
 * allowMultiplMatches attribute set to false.
 */
public class MultipleMatchesException extends BuildException {

    private File multiplyMatchedPath;
    private MatchSelector[] matchers;

    public MultipleMatchesException (File multiplyMatchedPath,
                                     MatchSelector[] matchers) {
        this.multiplyMatchedPath = multiplyMatchedPath;
        this.matchers = matchers;
    }

    /**
     * Get the path that multiple selectors matched on.
     */
    public File getPath () {
        return multiplyMatchedPath;
    }

    /**
     * Get the absolute path String that multiple selectors matched on.
     */
    public String getPathString () {
        return multiplyMatchedPath.getAbsolutePath();
    }

    /**
     * Get the MatchSelectors that matched this path.
     */
    public MatchSelector[] getMatchers () {
        return matchers;
    }
}