View Javadoc

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  
20  package org.apache.james.mime4j.message;
21  
22  import java.io.IOException;
23  import java.io.Reader;
24  
25  /**
26   * Encapsulates the contents of a <code>text/*</code> entity body.
27   */
28  public abstract class TextBody extends SingleBody {
29  
30      /**
31       * Sole constructor.
32       */
33      protected TextBody() {
34      }
35  
36      /**
37       * Returns the MIME charset of this text body.
38       * 
39       * @return the MIME charset.
40       */
41      public abstract String getMimeCharset();
42  
43      /**
44       * Gets a <code>Reader</code> which may be used to read out the contents
45       * of this body.
46       * 
47       * @return the <code>Reader</code>.
48       * @throws IOException
49       *             on I/O errors.
50       */
51      public abstract Reader getReader() throws IOException;
52  
53  }