Author: maarten
Date: Fri Jan 11 13:59:43 2008
New Revision: 611312
URL: http://svn.apache.org/viewvc?rev=611312&view=rev
Log:
added javadoc for getPrefixedString
Modified:
mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoBuffer.java
Modified:
mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoBuffer.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoBuffer.java?rev=611312&r1=611311&r2=611312&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoBuffer.java
(original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoBuffer.java
Fri Jan 11 13:59:43 2008
@@ -1337,6 +1337,16 @@
return getPrefixedString(2, decoder);
}
+ /**
+ * Reads a string which has a length field before the actual
+ * encoded string, using the specified <code>decoder</code> and returns it.
+ *
+ * @param prefixLength the length of the length field (1, 2, or 4)
+ * @param decoder the decoder to use for decoding the string
+ * @return the prefixed string
+ * @throws CharacterCodingException when decoding fails
+ * @throws BufferUnderflowException when there is not enough data available
+ */
@Override
public String getPrefixedString(int prefixLength, CharsetDecoder decoder)
throws CharacterCodingException {
