/****************************************************************
 * 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.james.mime4j.stream;

import org.apache.james.mime4j.MimeException;

/**
 * Indicates that strict parsing has been enabled
 * and an optional invality has been found in the input.
 * {@link #getEvent()} indicates the type of invalidity.
 */
public class MimeParseEventException extends MimeException {

    private static final long serialVersionUID = 4632991604246852302L;
    private final Event event;

    /**
     * Constructs an exception
     * @param event <code>MimeTokenStream.Event</code>, not null
     */
    public MimeParseEventException(final Event event) {
        super(event.toString());
        this.event = event;
    }

    /**
     * Gets the causal parse event.
     * @return <code>MimeTokenStream.Event</code>, not null
     */
    public Event getEvent() {
        return event;
    }
}
