src/main/java/org/apache/james/mime4j/BufferingInputStream.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
  20 package org.apache.james.mime4j;
  21
  22 import java.io.IOException;
  23 import java.io.InputStream;
  24
  25 /**
  26  * Input stream capable of reading lines of text.
  27  */
  28 public abstract class BufferingInputStream extends InputStream {
  29
  30     /**
  31      * Reads one line of text into the given {@link ByteArrayBuffer}.
  32      *
  33      * @param dst Destination
  34      * @return number of bytes copied or <code>-1</code> if the end of
  35      * the stream has been reached.
  36      *
  37      * @throws IOException in case of an I/O error.
  38      */
  39     public abstract int readLine(final ByteArrayBuffer dst) throws IOException;
  40
  41 }