/*

 * Copyright 2007-2009 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code 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

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package java.nio.file;

/**

 * Unchecked exception thrown when path string cannot be converted into a

 * {@link Path} because the path string contains invalid characters, or

 * the path string is invalid for other file system specific reasons.

 */

public class InvalidPathException

    extends IllegalArgumentException

{

    static final long serialVersionUID = 4355821422286746137L;

    private String input;

    private int index;

    /**

     * Constructs an instance from the given input string, reason, and error

     * index.

     *

     * @param  input   The input string

     * @param  reason  A string explaining why the input was rejected

     * @param  index   The index at which the error occurred,

     *                 or <tt>-1</tt> if the index is not known

     *

     * @throws  NullPointerException

     *          If either the input or reason strings are <tt>null</tt>

     *

     * @throws  IllegalArgumentException

     *          If the error index is less than <tt>-1</tt>

     */

    public InvalidPathException(String input, String reason, int index) {

        super(reason);

        if ((input == null) || (reason == null))

            throw new NullPointerException();

        if (index < -1)

            throw new IllegalArgumentException();

        this.input = input;

        this.index = index;

    }

    /**

     * Constructs an instance from the given input string and reason.  The

     * resulting object will have an error index of <tt>-1</tt>.

     *

     * @param  input   The input string

     * @param  reason  A string explaining why the input was rejected

     *

     * @throws  NullPointerException

     *          If either the input or reason strings are <tt>null</tt>

     */

    public InvalidPathException(String input, String reason) {

        this(input, reason, -1);

    }

    /**

     * Returns the input string.

     *

     * @return  The input string

     */

    public String getInput() {

        return input;

    }

    /**

     * Returns a string explaining why the input string was rejected.

     *

     * @return  The reason string

     */

    public String getReason() {

        return super.getMessage();

    }

    /**

     * Returns an index into the input string of the position at which the

     * error occurred, or <tt>-1</tt> if this position is not known.

     *

     * @return  The error index

     */

    public int getIndex() {

        return index;

    }

    /**

     * Returns a string describing the error.  The resulting string

     * consists of the reason string followed by a colon character

     * (<tt>':'</tt>), a space, and the input string.  If the error index is

     * defined then the string <tt>" at index "</tt> followed by the index, in

     * decimal, is inserted after the reason string and before the colon

     * character.

     *

     * @return  A string describing the error

     */

    public String getMessage() {

        StringBuffer sb = new StringBuffer();

        sb.append(getReason());

        if (index > -1) {

            sb.append(" at index ");

            sb.append(index);

        }

        sb.append(": ");

        sb.append(input);

        return sb.toString();

    }

}