Class TextLineEncoder
- java.lang.Object
-
- org.apache.mina.filter.codec.ProtocolEncoderAdapter
-
- org.apache.mina.filter.codec.textline.TextLineEncoder
-
- All Implemented Interfaces:
ProtocolEncoder
public class TextLineEncoder extends ProtocolEncoderAdapter
AProtocolEncoder
which encodes a string into a text line which ends with the delimiter.
-
-
Constructor Summary
Constructors Constructor Description TextLineEncoder()
TextLineEncoder(java.nio.charset.Charset charset)
TextLineEncoder(java.nio.charset.Charset charset, LineDelimiter delimiter)
TextLineEncoder(LineDelimiter delimiter)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
dispose()
void
encode(IoSession session, java.lang.Object message, ProtocolEncoderOutput out)
Encodes higher-level message objects into binary or protocol-specific data.int
getMaxLineLength()
Returns the allowed maximum size of the encoded line.void
setMaxLineLength(int maxLineLength)
Sets the allowed maximum size of the encoded line.-
Methods inherited from class org.apache.mina.filter.codec.ProtocolEncoderAdapter
dispose
-
-
-
-
Constructor Detail
-
TextLineEncoder
public TextLineEncoder()
-
TextLineEncoder
public TextLineEncoder(LineDelimiter delimiter)
-
TextLineEncoder
public TextLineEncoder(java.nio.charset.Charset charset)
-
TextLineEncoder
public TextLineEncoder(java.nio.charset.Charset charset, LineDelimiter delimiter)
-
-
Method Detail
-
getMaxLineLength
public int getMaxLineLength()
Returns the allowed maximum size of the encoded line. If the size of the encoded line exceeds this value, the encoder will throw aIllegalArgumentException
. The default value isInteger.MAX_VALUE
.
-
setMaxLineLength
public void setMaxLineLength(int maxLineLength)
Sets the allowed maximum size of the encoded line. If the size of the encoded line exceeds this value, the encoder will throw aIllegalArgumentException
. The default value isInteger.MAX_VALUE
.
-
encode
public void encode(IoSession session, java.lang.Object message, ProtocolEncoderOutput out) throws java.lang.Exception
Description copied from interface:ProtocolEncoder
Encodes higher-level message objects into binary or protocol-specific data. MINA invokesProtocolEncoder.encode(IoSession, Object, ProtocolEncoderOutput)
method with message which is popped from the session write queue, and then the encoder implementation puts encodedByteBuffer
s intoProtocolEncoderOutput
.- Throws:
java.lang.Exception
- if the message violated protocol specification
-
dispose
public void dispose() throws java.lang.Exception
- Throws:
java.lang.Exception
-
-