Author: toad
Date: 2007-09-20 21:33:40 +0000 (Thu, 20 Sep 2007)
New Revision: 15212
Modified:
trunk/freenet/src/freenet/support/io/LineReadingInputStream.java
Log:
javadocs
Modified: trunk/freenet/src/freenet/support/io/LineReadingInputStream.java
===================================================================
--- trunk/freenet/src/freenet/support/io/LineReadingInputStream.java
2007-09-20 21:00:56 UTC (rev 15211)
+++ trunk/freenet/src/freenet/support/io/LineReadingInputStream.java
2007-09-20 21:33:40 UTC (rev 15212)
@@ -20,6 +20,10 @@
/**
* Read a \n or \r\n terminated line of UTF-8 or ISO-8859-1.
+ * @param maxLength The maximum length of a line. If a line is longer
than this, we throw IOException rather
+ * than keeping on reading it forever.
+ * @param bufferSize The initial size of the read buffer.
+ * @param utf If true, read as UTF-8, if false, read as ISO-8859-1.
*/
public String readLine(int maxLength, int bufferSize, boolean utf)
throws IOException {
if(maxLength < bufferSize)
