blob: 8f8745bacbad8e51583b7cd07be42885011a7bd0 [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>SerialAddress xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/mina/transport/serial/SerialAddress.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>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">package</strong> org.apache.mina.transport.serial;
<a name="22" href="#22">22</a>
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> gnu.io.SerialPort;
<a name="24" href="#24">24</a>
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.net.SocketAddress;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.security.InvalidParameterException;
<a name="27" href="#27">27</a>
<a name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em>
<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * An address for a serial port communication.</em>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> *</em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * @author The Apache MINA Project (dev@mina.apache.org)</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> */</em>
<a name="33" href="#33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">SerialAddress</a> <strong class="jxr_keyword">extends</strong> SocketAddress {
<a name="34" href="#34">34</a>
<a name="35" href="#35">35</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 1735370510442384505L;
<a name="36" href="#36">36</a>
<a name="37" href="#37">37</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">DataBits</a> {
<a name="38" href="#38">38</a> DATABITS_5, DATABITS_6, DATABITS_7, DATABITS_8
<a name="39" href="#39">39</a> }
<a name="40" href="#40">40</a>
<a name="41" href="#41">41</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">Parity</a> {
<a name="42" href="#42">42</a> NONE, ODD, EVEN, MARK, SPACE
<a name="43" href="#43">43</a> }
<a name="44" href="#44">44</a>
<a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">StopBits</a> {
<a name="46" href="#46">46</a> BITS_1, BITS_2, BITS_1_5
<a name="47" href="#47">47</a> }
<a name="48" href="#48">48</a>
<a name="49" href="#49">49</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">FlowControl</a> {
<a name="50" href="#50">50</a> NONE, RTSCTS_IN, RTSCTS_OUT, XONXOFF_IN, XONXOFF_OUT
<a name="51" href="#51">51</a> }
<a name="52" href="#52">52</a>
<a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String name;
<a name="54" href="#54">54</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> bauds;
<a name="55" href="#55">55</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">DataBits</a> dataBits;
<a name="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">StopBits</a> stopBits;
<a name="57" href="#57">57</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">Parity</a> parity;
<a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">FlowControl</a> flowControl;
<a name="59" href="#59">59</a>
<a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Create an address for a serial communication, associating a serial interface and</em>
<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * various serial signal carcteristics.</em>
<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @param name name of the device, COM1 COM2 for Windows, /dev/ttyS0 for Unix</em>
<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @param bauds baud rate for the communication</em>
<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @param dataBits number of data bits per bytes</em>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * @param stopBits number of stop bits</em>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @param parity parity used</em>
<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * @param flowControl flow control used</em>
<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> */</em>
<a name="70" href="#70">70</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">SerialAddress</a>(String name, <strong class="jxr_keyword">int</strong> bauds, <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">DataBits</a> dataBits,
<a name="71" href="#71">71</a> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">StopBits</a> stopBits, <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">Parity</a> parity, <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">FlowControl</a> flowControl) {
<a name="72" href="#72">72</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>) {
<a name="73" href="#73">73</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"name"</span>);
<a name="74" href="#74">74</a> }
<a name="75" href="#75">75</a> name = name.trim();
<a name="76" href="#76">76</a> <strong class="jxr_keyword">if</strong> (name.length() == 0) {
<a name="77" href="#77">77</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Empty name."</span>);
<a name="78" href="#78">78</a> }
<a name="79" href="#79">79</a> <strong class="jxr_keyword">if</strong> (bauds &lt;= 0) {
<a name="80" href="#80">80</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"bauds: "</span> + bauds);
<a name="81" href="#81">81</a> }
<a name="82" href="#82">82</a> <strong class="jxr_keyword">if</strong> (dataBits == <strong class="jxr_keyword">null</strong>) {
<a name="83" href="#83">83</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"dataBits"</span>);
<a name="84" href="#84">84</a> }
<a name="85" href="#85">85</a> <strong class="jxr_keyword">if</strong> (stopBits == <strong class="jxr_keyword">null</strong>) {
<a name="86" href="#86">86</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"stopBits"</span>);
<a name="87" href="#87">87</a> }
<a name="88" href="#88">88</a> <strong class="jxr_keyword">if</strong> (parity == <strong class="jxr_keyword">null</strong>) {
<a name="89" href="#89">89</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"parity"</span>);
<a name="90" href="#90">90</a> }
<a name="91" href="#91">91</a> <strong class="jxr_keyword">if</strong> (flowControl == <strong class="jxr_keyword">null</strong>) {
<a name="92" href="#92">92</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"flowControl"</span>);
<a name="93" href="#93">93</a> }
<a name="94" href="#94">94</a>
<a name="95" href="#95">95</a> <strong class="jxr_keyword">this</strong>.name = name;
<a name="96" href="#96">96</a> <strong class="jxr_keyword">this</strong>.bauds = bauds;
<a name="97" href="#97">97</a> <strong class="jxr_keyword">this</strong>.dataBits = dataBits;
<a name="98" href="#98">98</a> <strong class="jxr_keyword">this</strong>.stopBits = stopBits;
<a name="99" href="#99">99</a> <strong class="jxr_keyword">this</strong>.parity = parity;
<a name="100" href="#100">100</a> <strong class="jxr_keyword">this</strong>.flowControl = flowControl;
<a name="101" href="#101">101</a> }
<a name="102" href="#102">102</a>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">/**</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * Bauds rate for the communication.</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * @return the bauds (bits per seconds) for this serial link</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> */</em>
<a name="107" href="#107">107</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getBauds() {
<a name="108" href="#108">108</a> <strong class="jxr_keyword">return</strong> bauds;
<a name="109" href="#109">109</a> }
<a name="110" href="#110">110</a>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">/**</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * Number of data bits for each communicated bytes.</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * @return the data bits</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> */</em>
<a name="115" href="#115">115</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">DataBits</a> getDataBits() {
<a name="116" href="#116">116</a> <strong class="jxr_keyword">return</strong> dataBits;
<a name="117" href="#117">117</a> }
<a name="118" href="#118">118</a>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">/**</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * The flow control policie used for this communication.</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @return the flow control</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> */</em>
<a name="123" href="#123">123</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">FlowControl</a> getFlowControl() {
<a name="124" href="#124">124</a> <strong class="jxr_keyword">return</strong> flowControl;
<a name="125" href="#125">125</a> }
<a name="126" href="#126">126</a>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">/**</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * The name of the device. Can be COM1, COM2, /dev/ttyS0, /dev/ttyUSB1, etc..</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * @return name</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> */</em>
<a name="131" href="#131">131</a> <strong class="jxr_keyword">public</strong> String getName() {
<a name="132" href="#132">132</a> <strong class="jxr_keyword">return</strong> name;
<a name="133" href="#133">133</a> }
<a name="134" href="#134">134</a>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">/**</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * The parity check for this communication.</em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * @return parity type</em>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> */</em>
<a name="139" href="#139">139</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">Parity</a> getParity() {
<a name="140" href="#140">140</a> <strong class="jxr_keyword">return</strong> parity;
<a name="141" href="#141">141</a> }
<a name="142" href="#142">142</a>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">/**</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * Number of stop bits used.</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * @return stop bits number</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> */</em>
<a name="147" href="#147">147</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">StopBits</a> getStopBits() {
<a name="148" href="#148">148</a> <strong class="jxr_keyword">return</strong> stopBits;
<a name="149" href="#149">149</a> }
<a name="150" href="#150">150</a>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">/**</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * Convert this serial address to a human readable string.</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> */</em>
<a name="154" href="#154">154</a> @Override
<a name="155" href="#155">155</a> <strong class="jxr_keyword">public</strong> String toString() {
<a name="156" href="#156">156</a> <strong class="jxr_keyword">return</strong> name + <span class="jxr_string">" (bauds: "</span> + bauds + <span class="jxr_string">", dataBits: "</span> + dataBits
<a name="157" href="#157">157</a> + <span class="jxr_string">", stopBits: "</span> + stopBits + <span class="jxr_string">", parity: "</span> + parity
<a name="158" href="#158">158</a> + <span class="jxr_string">", flowControl: "</span> + flowControl + <span class="jxr_string">")"</span>;
<a name="159" href="#159">159</a> }
<a name="160" href="#160">160</a>
<a name="161" href="#161">161</a> <strong class="jxr_keyword">int</strong> getDataBitsForRXTX() {
<a name="162" href="#162">162</a> <strong class="jxr_keyword">switch</strong> (dataBits) {
<a name="163" href="#163">163</a> <strong class="jxr_keyword">case</strong> DATABITS_5:
<a name="164" href="#164">164</a> <strong class="jxr_keyword">return</strong> SerialPort.DATABITS_5;
<a name="165" href="#165">165</a> <strong class="jxr_keyword">case</strong> DATABITS_6:
<a name="166" href="#166">166</a> <strong class="jxr_keyword">return</strong> SerialPort.DATABITS_6;
<a name="167" href="#167">167</a> <strong class="jxr_keyword">case</strong> DATABITS_7:
<a name="168" href="#168">168</a> <strong class="jxr_keyword">return</strong> SerialPort.DATABITS_7;
<a name="169" href="#169">169</a> <strong class="jxr_keyword">case</strong> DATABITS_8:
<a name="170" href="#170">170</a> <strong class="jxr_keyword">return</strong> SerialPort.DATABITS_8;
<a name="171" href="#171">171</a> }
<a name="172" href="#172">172</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> InvalidParameterException(<span class="jxr_string">"broken databits"</span>);
<a name="173" href="#173">173</a> }
<a name="174" href="#174">174</a>
<a name="175" href="#175">175</a> <strong class="jxr_keyword">int</strong> getStopBitsForRXTX() {
<a name="176" href="#176">176</a> <strong class="jxr_keyword">switch</strong> (stopBits) {
<a name="177" href="#177">177</a> <strong class="jxr_keyword">case</strong> BITS_1:
<a name="178" href="#178">178</a> <strong class="jxr_keyword">return</strong> SerialPort.STOPBITS_1;
<a name="179" href="#179">179</a> <strong class="jxr_keyword">case</strong> BITS_1_5:
<a name="180" href="#180">180</a> <strong class="jxr_keyword">return</strong> SerialPort.STOPBITS_1_5;
<a name="181" href="#181">181</a> <strong class="jxr_keyword">case</strong> BITS_2:
<a name="182" href="#182">182</a> <strong class="jxr_keyword">return</strong> SerialPort.STOPBITS_2;
<a name="183" href="#183">183</a> }
<a name="184" href="#184">184</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> InvalidParameterException(<span class="jxr_string">"broken stopbits"</span>);
<a name="185" href="#185">185</a> }
<a name="186" href="#186">186</a>
<a name="187" href="#187">187</a> <strong class="jxr_keyword">int</strong> getParityForRXTX() {
<a name="188" href="#188">188</a> <strong class="jxr_keyword">switch</strong> (parity) {
<a name="189" href="#189">189</a> <strong class="jxr_keyword">case</strong> EVEN:
<a name="190" href="#190">190</a> <strong class="jxr_keyword">return</strong> SerialPort.PARITY_EVEN;
<a name="191" href="#191">191</a> <strong class="jxr_keyword">case</strong> MARK:
<a name="192" href="#192">192</a> <strong class="jxr_keyword">return</strong> SerialPort.PARITY_MARK;
<a name="193" href="#193">193</a> <strong class="jxr_keyword">case</strong> NONE:
<a name="194" href="#194">194</a> <strong class="jxr_keyword">return</strong> SerialPort.PARITY_NONE;
<a name="195" href="#195">195</a> <strong class="jxr_keyword">case</strong> ODD:
<a name="196" href="#196">196</a> <strong class="jxr_keyword">return</strong> SerialPort.PARITY_ODD;
<a name="197" href="#197">197</a> <strong class="jxr_keyword">case</strong> SPACE:
<a name="198" href="#198">198</a> <strong class="jxr_keyword">return</strong> SerialPort.PARITY_SPACE;
<a name="199" href="#199">199</a> }
<a name="200" href="#200">200</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> InvalidParameterException(<span class="jxr_string">"broken parity"</span>);
<a name="201" href="#201">201</a> }
<a name="202" href="#202">202</a>
<a name="203" href="#203">203</a> <strong class="jxr_keyword">int</strong> getFLowControlForRXTX() {
<a name="204" href="#204">204</a> <strong class="jxr_keyword">switch</strong> (flowControl) {
<a name="205" href="#205">205</a> <strong class="jxr_keyword">case</strong> NONE:
<a name="206" href="#206">206</a> <strong class="jxr_keyword">return</strong> SerialPort.FLOWCONTROL_NONE;
<a name="207" href="#207">207</a> <strong class="jxr_keyword">case</strong> RTSCTS_IN:
<a name="208" href="#208">208</a> <strong class="jxr_keyword">return</strong> SerialPort.FLOWCONTROL_RTSCTS_IN;
<a name="209" href="#209">209</a> <strong class="jxr_keyword">case</strong> RTSCTS_OUT:
<a name="210" href="#210">210</a> <strong class="jxr_keyword">return</strong> SerialPort.FLOWCONTROL_RTSCTS_OUT;
<a name="211" href="#211">211</a> <strong class="jxr_keyword">case</strong> XONXOFF_IN:
<a name="212" href="#212">212</a> <strong class="jxr_keyword">return</strong> SerialPort.FLOWCONTROL_XONXOFF_IN;
<a name="213" href="#213">213</a> <strong class="jxr_keyword">case</strong> XONXOFF_OUT:
<a name="214" href="#214">214</a> <strong class="jxr_keyword">return</strong> SerialPort.FLOWCONTROL_XONXOFF_OUT;
<a name="215" href="#215">215</a> }
<a name="216" href="#216">216</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> InvalidParameterException(<span class="jxr_string">"broken stopbits"</span>);
<a name="217" href="#217">217</a> }
<a name="218" href="#218">218</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>