001/****************************************************************
002 * Licensed to the Apache Software Foundation (ASF) under one   *
003 * or more contributor license agreements.  See the NOTICE file *
004 * distributed with this work for additional information        *
005 * regarding copyright ownership.  The ASF licenses this file   *
006 * to you under the Apache License, Version 2.0 (the            *
007 * "License"); you may not use this file except in compliance   *
008 * with the License.  You may obtain a copy of the License at   *
009 *                                                              *
010 *   http://www.apache.org/licenses/LICENSE-2.0                 *
011 *                                                              *
012 * Unless required by applicable law or agreed to in writing,   *
013 * software distributed under the License is distributed on an  *
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
015 * KIND, either express or implied.  See the License for the    *
016 * specific language governing permissions and limitations      *
017 * under the License.                                           *
018 ****************************************************************/
019
020package org.apache.james.mime4j.stream;
021
022import org.apache.james.mime4j.MimeException;
023
024/**
025 * Indicates that strict parsing has been enabled
026 * and an optional invality has been found in the input.
027 * {@link #getEvent()} indicates the type of invalidity.
028 */
029public class MimeParseEventException extends MimeException {
030
031    private static final long serialVersionUID = 4632991604246852302L;
032    private final Event event;
033
034    /**
035     * Constructs an exception
036     * @param event <code>MimeTokenStream.Event</code>, not null
037     */
038    public MimeParseEventException(final Event event) {
039        super(event.toString());
040        this.event = event;
041    }
042
043    /**
044     * Gets the causal parse event.
045     * @return <code>MimeTokenStream.Event</code>, not null
046     */
047    public Event getEvent() {
048        return event;
049    }
050}