jakarta.mail.util.LineInputStream Maven / Gradle / Ivy
/*
* Copyright (c) 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.mail.util;
import java.io.IOException;
/**
* LineInputStream supports reading CRLF terminated lines that
* contain only US-ASCII characters from an input stream. Provides
* functionality that is similar to the deprecated
* DataInputStream.readLine(). Expected use is to read
* lines as String objects from an IMAP/SMTP/etc. stream.
*
* This class also supports UTF-8 data by calling the appropriate
* constructor. Or, if the System property mail.mime.allowutf8
* is set to true, an attempt will be made to interpret the data as UTF-8,
* falling back to treating it as an 8-bit charset if that fails.
*
*/
public interface LineInputStream {
/**
* Read a line containing only ASCII characters from the input
* stream. A line is terminated by a CR or NL or CR-NL sequence.
* A common error is a CR-CR-NL sequence, which will also terminate
* a line.
* The line terminator is not returned as part of the returned
* String. Returns null if no data is available.
*
* @return the line
* @exception IOException for I/O errors
*/
String readLine() throws IOException;
}