InvalidSyntaxException.java

/*
 * Copyright (c) OSGi Alliance (2000, 2008). All Rights Reserved.
 * 
 * Licensed 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.osgi.framework;

/**
 * A Framework exception used to indicate that a filter string has an invalid
 * syntax.
 * <p>
 * <p>
 * An <code>InvalidSyntaxException</code> object indicates that a filter
 * string parameter has an invalid syntax and cannot be parsed. See
 * {@link Filter} for a description of the filter string syntax.
 * <p>
 * <p>
 * This exception conforms to the general purpose exception chaining mechanism.
 *
 * @version $Revision: 6083 $
 */

public class InvalidSyntaxException extends Exception {
    static final long serialVersionUID = -4295194420816491875L;
    /**
     * The invalid filter string.
     */
    private final String filter;

    /**
     * Creates an exception of type <code>InvalidSyntaxException</code>.
     * <p>
     * <p>
     * This method creates an <code>InvalidSyntaxException</code> object with
     * the specified message and the filter string which generated the
     * exception.
     *
     * @param msg    The message.
     * @param filter The invalid filter string.
     */
    public InvalidSyntaxException(String msg, String filter) {
        super(msg);
        this.filter = filter;
    }

    /**
     * Creates an exception of type <code>InvalidSyntaxException</code>.
     * <p>
     * <p>
     * This method creates an <code>InvalidSyntaxException</code> object with
     * the specified message and the filter string which generated the
     * exception.
     *
     * @param msg    The message.
     * @param filter The invalid filter string.
     * @param cause  The cause of this exception.
     * @since 1.3
     */
    public InvalidSyntaxException(String msg, String filter, Throwable cause) {
        super(msg, cause);
        this.filter = filter;
    }

    /**
     * Returns the filter string that generated the
     * <code>InvalidSyntaxException</code> object.
     *
     * @return The invalid filter string.
     */
    public String getFilter() {
        return filter;
    }

    /**
     * Returns the cause of this exception or <code>null</code> if no cause was
     * set.
     *
     * @return The cause of this exception or <code>null</code> if no cause was
     * set.
     * @since 1.3
     */
    @Override
    public Throwable getCause() {
        return super.getCause();
    }

    /**
     * Initializes the cause of this exception to the specified value.
     *
     * @param cause The cause of this exception.
     * @return This exception.
     * @throws IllegalArgumentException If the specified cause is this
     *                                  exception.
     * @throws IllegalStateException    If the cause of this exception has already
     *                                  been set.
     * @since 1.3
     */
    @Override
    public Throwable initCause(Throwable cause) {
        return super.initCause(cause);
    }
}