src/main/java/org/apache/james/mime4j/RFC2045MimeDescriptor.java

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one
   3  * or more contributor license agreements.  See the NOTICE file
   4  * distributed with this work for additional information
   5  * regarding copyright ownership.  The ASF licenses this file
   6  * to you under the Apache License, Version 2.0 (the
   7  * "License"); you may not use this file except in compliance
   8  * with the License.  You may obtain a copy of the License at
   9  *
  10  *   http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing,
  13  * software distributed under the License is distributed on an
  14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15  * KIND, either express or implied.  See the License for the
  16  * specific language governing permissions and limitations
  17  * under the License.
  18  */
  19 package org.apache.james.mime4j;
  20
  21 /**
  22  * Describes standard <a href='http://www.faqs.org/rfcs/rfc2045.html' rel='tag'>RFC2045</a>
  23  * headers.
  24  */
  25 public interface RFC2045MimeDescriptor extends ContentDescriptor {
  26
  27     /**
  28      * Gets the MIME major version
  29      * as specified by the <code>MIME-Version</code>
  30      * header.
  31      * Defaults to one.
  32      * @return positive integer
  33      */
  34     public abstract int getMimeMajorVersion();
  35
  36     /**
  37      * Gets the MIME minor version
  38      * as specified by the <code>MIME-Version</code>
  39      * header.
  40      * Defaults to zero.
  41      * @return positive integer
  42      */
  43     public abstract int getMimeMinorVersion();
  44
  45     /**
  46      * When the MIME version header exists but cannot be parsed
  47      * this field will be contain the exception.
  48      * @return <code>MimeException</code> if the mime header cannot
  49      * be parsed, null otherwise
  50      */
  51     public abstract MimeException getMimeVersionParseException();
  52
  53     /**
  54      * Gets the value of the <a href='http://www.faqs.org/rfcs/rfc2045'>RFC</a>
  55      * <code>Content-Description</code> header.
  56      * @return value of the <code>Content-Description</code> when present,
  57      * null otherwise
  58      */
  59     public abstract String getContentDescription();
  60
  61     /**
  62      * Gets the value of the <a href='http://www.faqs.org/rfcs/rfc2045'>RFC</a>
  63      * <code>Content-ID</code> header.
  64      * @return value of the <code>Content-ID</code> when present,
  65      * null otherwise
  66      */
  67     public abstract String getContentId();
  68
  69 }