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    
020    package org.apache.james.mime4j;
021    
022    import java.io.IOException;
023    
024    /**
025     * A wrapper class based on {@link IOException} for MIME protocol exceptions.
026     * <p>
027     * This exception is used to signal a <code>MimeException</code> in methods
028     * that only permit <code>IOException</code> to be thrown.
029     * <p>
030     * The cause of a <code>MimeIOException</code> is always a
031     * <code>MimeException</code> therefore.
032     */
033    public class MimeIOException extends IOException {
034    
035        private static final long serialVersionUID = 5393613459533735409L;
036    
037        /**
038         * Constructs an IO exception based on {@link MimeException}.
039         *
040         * @param cause the cause.
041         */
042        public MimeIOException(MimeException cause) {
043            super(cause == null ? null : cause.getMessage());
044            initCause(cause);
045        }
046    
047        /**
048         * Returns the <code>MimeException</code> that caused this
049         * <code>MimeIOException</code>.
050         *
051         * @return the cause of this <code>MimeIOException</code>.
052         */
053        @Override
054        public MimeException getCause() {
055            return (MimeException) super.getCause();
056        }
057    
058    }