Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 2.0.0-M2 / xref / org / apache / mina / filter / codec / textline / TextLineEncoder.html
blob: e1d65b94ad4a0d3818a26d2874b9d87a075836c9 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>TextLineEncoder xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/mina/filter/codec/textline/TextLineEncoder.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> *</em>
<a name="19" href="#19">19</a> <em class="jxr_comment"> */</em>
<a name="20" href="#20">20</a> <strong class="jxr_keyword">package</strong> org.apache.mina.filter.codec.textline;
<a name="21" href="#21">21</a>
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.nio.charset.Charset;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.nio.charset.CharsetEncoder;
<a name="24" href="#24">24</a>
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.buffer.IoBuffer;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.session.AttributeKey;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.session.IoSession;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.mina.filter.codec.ProtocolEncoder;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.mina.filter.codec.ProtocolEncoderAdapter;
<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.mina.filter.codec.ProtocolEncoderOutput;
<a name="31" href="#31">31</a>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * A {@link ProtocolEncoder} which encodes a string into a text line</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * which ends with the delimiter.</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> *</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * @author The Apache MINA Project (dev@mina.apache.org)</em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @version $Rev: 671827 $, $Date: 2008-06-26 10:49:48 +0200 (jeu, 26 jun 2008) $,</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> */</em>
<a name="39" href="#39">39</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineEncoder.html">TextLineEncoder</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/mina/filter/codec/ProtocolEncoderAdapter.html">ProtocolEncoderAdapter</a> {
<a name="40" href="#40">40</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/mina/core/session/AttributeKey.html">AttributeKey</a> ENCODER = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/mina/core/session/AttributeKey.html">AttributeKey</a>(getClass(), <span class="jxr_string">"encoder"</span>);
<a name="41" href="#41">41</a>
<a name="42" href="#42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Charset charset;
<a name="43" href="#43">43</a>
<a name="44" href="#44">44</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/mina/filter/codec/textline/LineDelimiter.html">LineDelimiter</a> delimiter;
<a name="45" href="#45">45</a>
<a name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> maxLineLength = Integer.MAX_VALUE;
<a name="47" href="#47">47</a>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Creates a new instance with the current default {@link Charset}</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * and {@link LineDelimiter#UNIX} delimiter.</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em>
<a name="52" href="#52">52</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineEncoder.html">TextLineEncoder</a>() {
<a name="53" href="#53">53</a> <strong class="jxr_keyword">this</strong>(Charset.defaultCharset(), LineDelimiter.UNIX);
<a name="54" href="#54">54</a> }
<a name="55" href="#55">55</a>
<a name="56" href="#56">56</a> <em class="jxr_javadoccomment">/**</em>
<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * Creates a new instance with the current default {@link Charset}</em>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * and the specified &lt;tt&gt;delimiter&lt;/tt&gt;.</em>
<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> */</em>
<a name="60" href="#60">60</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineEncoder.html">TextLineEncoder</a>(String delimiter) {
<a name="61" href="#61">61</a> <strong class="jxr_keyword">this</strong>(<strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/mina/filter/codec/textline/LineDelimiter.html">LineDelimiter</a>(delimiter));
<a name="62" href="#62">62</a> }
<a name="63" href="#63">63</a>
<a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em>
<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Creates a new instance with the current default {@link Charset}</em>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * and the specified &lt;tt&gt;delimiter&lt;/tt&gt;.</em>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> */</em>
<a name="68" href="#68">68</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineEncoder.html">TextLineEncoder</a>(<a href="../../../../../../org/apache/mina/filter/codec/textline/LineDelimiter.html">LineDelimiter</a> delimiter) {
<a name="69" href="#69">69</a> <strong class="jxr_keyword">this</strong>(Charset.defaultCharset(), delimiter);
<a name="70" href="#70">70</a> }
<a name="71" href="#71">71</a>
<a name="72" href="#72">72</a> <em class="jxr_javadoccomment">/**</em>
<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * Creates a new instance with the spcified &lt;tt&gt;charset&lt;/tt&gt;</em>
<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * and {@link LineDelimiter#UNIX} delimiter.</em>
<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em>
<a name="76" href="#76">76</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineEncoder.html">TextLineEncoder</a>(Charset charset) {
<a name="77" href="#77">77</a> <strong class="jxr_keyword">this</strong>(charset, LineDelimiter.UNIX);
<a name="78" href="#78">78</a> }
<a name="79" href="#79">79</a>
<a name="80" href="#80">80</a> <em class="jxr_javadoccomment">/**</em>
<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * Creates a new instance with the spcified &lt;tt&gt;charset&lt;/tt&gt;</em>
<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * and the specified &lt;tt&gt;delimiter&lt;/tt&gt;.</em>
<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> */</em>
<a name="84" href="#84">84</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineEncoder.html">TextLineEncoder</a>(Charset charset, String delimiter) {
<a name="85" href="#85">85</a> <strong class="jxr_keyword">this</strong>(charset, <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/mina/filter/codec/textline/LineDelimiter.html">LineDelimiter</a>(delimiter));
<a name="86" href="#86">86</a> }
<a name="87" href="#87">87</a>
<a name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em>
<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * Creates a new instance with the spcified &lt;tt&gt;charset&lt;/tt&gt;</em>
<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * and the specified &lt;tt&gt;delimiter&lt;/tt&gt;.</em>
<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> */</em>
<a name="92" href="#92">92</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineEncoder.html">TextLineEncoder</a>(Charset charset, <a href="../../../../../../org/apache/mina/filter/codec/textline/LineDelimiter.html">LineDelimiter</a> delimiter) {
<a name="93" href="#93">93</a> <strong class="jxr_keyword">if</strong> (charset == <strong class="jxr_keyword">null</strong>) {
<a name="94" href="#94">94</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"charset"</span>);
<a name="95" href="#95">95</a> }
<a name="96" href="#96">96</a> <strong class="jxr_keyword">if</strong> (delimiter == <strong class="jxr_keyword">null</strong>) {
<a name="97" href="#97">97</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"delimiter"</span>);
<a name="98" href="#98">98</a> }
<a name="99" href="#99">99</a> <strong class="jxr_keyword">if</strong> (LineDelimiter.AUTO.equals(delimiter)) {
<a name="100" href="#100">100</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a name="101" href="#101">101</a> <span class="jxr_string">"AUTO delimiter is not allowed for encoder."</span>);
<a name="102" href="#102">102</a> }
<a name="103" href="#103">103</a>
<a name="104" href="#104">104</a> <strong class="jxr_keyword">this</strong>.charset = charset;
<a name="105" href="#105">105</a> <strong class="jxr_keyword">this</strong>.delimiter = delimiter;
<a name="106" href="#106">106</a> }
<a name="107" href="#107">107</a>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">/**</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * Returns the allowed maximum size of the encoded line.</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * If the size of the encoded line exceeds this value, the encoder</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * will throw a {@link IllegalArgumentException}. The default value</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * is {@link Integer#MAX_VALUE}.</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> */</em>
<a name="114" href="#114">114</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getMaxLineLength() {
<a name="115" href="#115">115</a> <strong class="jxr_keyword">return</strong> maxLineLength;
<a name="116" href="#116">116</a> }
<a name="117" href="#117">117</a>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">/**</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * Sets the allowed maximum size of the encoded line.</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * If the size of the encoded line exceeds this value, the encoder</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * will throw a {@link IllegalArgumentException}. The default value</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * is {@link Integer#MAX_VALUE}.</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> */</em>
<a name="124" href="#124">124</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setMaxLineLength(<strong class="jxr_keyword">int</strong> maxLineLength) {
<a name="125" href="#125">125</a> <strong class="jxr_keyword">if</strong> (maxLineLength &lt;= 0) {
<a name="126" href="#126">126</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"maxLineLength: "</span>
<a name="127" href="#127">127</a> + maxLineLength);
<a name="128" href="#128">128</a> }
<a name="129" href="#129">129</a>
<a name="130" href="#130">130</a> <strong class="jxr_keyword">this</strong>.maxLineLength = maxLineLength;
<a name="131" href="#131">131</a> }
<a name="132" href="#132">132</a>
<a name="133" href="#133">133</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> encode(<a href="../../../../../../org/apache/mina/core/session/IoSession.html">IoSession</a> session, Object message,
<a name="134" href="#134">134</a> <a href="../../../../../../org/apache/mina/filter/codec/ProtocolEncoderOutput.html">ProtocolEncoderOutput</a> out) <strong class="jxr_keyword">throws</strong> Exception {
<a name="135" href="#135">135</a> CharsetEncoder encoder = (CharsetEncoder) session.getAttribute(ENCODER);
<a name="136" href="#136">136</a> <strong class="jxr_keyword">if</strong> (encoder == <strong class="jxr_keyword">null</strong>) {
<a name="137" href="#137">137</a> encoder = charset.newEncoder();
<a name="138" href="#138">138</a> session.setAttribute(ENCODER, encoder);
<a name="139" href="#139">139</a> }
<a name="140" href="#140">140</a>
<a name="141" href="#141">141</a> String value = message.toString();
<a name="142" href="#142">142</a> <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> buf = IoBuffer.allocate(value.length())
<a name="143" href="#143">143</a> .setAutoExpand(<strong class="jxr_keyword">true</strong>);
<a name="144" href="#144">144</a> buf.putString(value, encoder);
<a name="145" href="#145">145</a> <strong class="jxr_keyword">if</strong> (buf.position() &gt; maxLineLength) {
<a name="146" href="#146">146</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Line length: "</span> + buf.position());
<a name="147" href="#147">147</a> }
<a name="148" href="#148">148</a> buf.putString(delimiter.getValue(), encoder);
<a name="149" href="#149">149</a> buf.flip();
<a name="150" href="#150">150</a> out.write(buf);
<a name="151" href="#151">151</a> }
<a name="152" href="#152">152</a>
<a name="153" href="#153">153</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> dispose() <strong class="jxr_keyword">throws</strong> Exception {
<a name="154" href="#154">154</a> }
<a name="155" href="#155">155</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>