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.dom.field;
021    
022    import org.apache.james.mime4j.stream.Field;
023    
024    /**
025     * A structured field that has been processed by a parsing routine.
026     */
027    public interface ParsedField extends Field {
028    
029        /**
030         * Returns <code>true</code> if this field is valid, i.e. no errors were
031         * encountered while parsing the field value.
032         *
033         * @return <code>true</code> if this field is valid, <code>false</code>
034         *         otherwise.
035         * @see #getParseException()
036         */
037        boolean isValidField();
038    
039        /**
040         * Returns the exception that was thrown by the field parser while parsing
041         * the field value. The result is <code>null</code> if the field is valid
042         * and no errors were encountered.
043         *
044         * @return the exception that was thrown by the field parser or
045         *         <code>null</code> if the field is valid.
046         */
047        ParseException getParseException();
048    
049    }