blob: fbcbca1c1d3b460e8569d351f2837b2195c707c5 [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 class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">package</strong> org.apache.mina.transport.serial;
<a class="jxr_linenumber" name="L22" href="#L22">22</a>
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> gnu.io.SerialPort;
<a class="jxr_linenumber" name="L24" href="#L24">24</a>
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.net.SocketAddress;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.security.InvalidParameterException;
<a class="jxr_linenumber" name="L27" href="#L27">27</a>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * An address for a serial port communication.</em>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="http://mina.apache.org" target="alexandria_uri">http://mina.apache.org</a>"&gt;Apache MINA Project&lt;/a&gt;</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L33" href="#L33">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 class="jxr_linenumber" name="L34" href="#L34">34</a>
<a class="jxr_linenumber" name="L35" href="#L35">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 class="jxr_linenumber" name="L36" href="#L36">36</a>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * The number of data bits per byte</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">DataBits</a> {
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/** 5 bits per bytes */</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> DATABITS_5,
<a class="jxr_linenumber" name="L43" href="#L43">43</a>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment">/** 6 bits per bytes */</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> DATABITS_6,
<a class="jxr_linenumber" name="L46" href="#L46">46</a>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment">/** 7 bits per bytes */</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> DATABITS_7,
<a class="jxr_linenumber" name="L49" href="#L49">49</a>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/** 8 bits per bytes */</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> DATABITS_8
<a class="jxr_linenumber" name="L52" href="#L52">52</a> }
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * The error detection parity in use</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">Parity</a> {
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment">/** No parity bit sent */</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> NONE,
<a class="jxr_linenumber" name="L61" href="#L61">61</a>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment">/** Odd parity */</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> ODD,
<a class="jxr_linenumber" name="L64" href="#L64">64</a>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/** Even parity */</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> EVEN,
<a class="jxr_linenumber" name="L67" href="#L67">67</a>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment">/** Mark signal condition */</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> MARK,
<a class="jxr_linenumber" name="L70" href="#L70">70</a>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment">/**Space signal condition */</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> SPACE
<a class="jxr_linenumber" name="L73" href="#L73">73</a> }
<a class="jxr_linenumber" name="L74" href="#L74">74</a>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * Stop bits in use</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">StopBits</a> {
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/** One bit */</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> BITS_1,
<a class="jxr_linenumber" name="L81" href="#L81">81</a>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment">/** Two bits */</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> BITS_2,
<a class="jxr_linenumber" name="L84" href="#L84">84</a>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/** one and half bits */</em>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> BITS_1_5
<a class="jxr_linenumber" name="L87" href="#L87">87</a> }
<a class="jxr_linenumber" name="L88" href="#L88">88</a>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * The Flow control flags</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">FlowControl</a> {
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment">/** No flow control */</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> NONE,
<a class="jxr_linenumber" name="L95" href="#L95">95</a>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment">/** RTS/CTS IN flow control */</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> RTSCTS_IN,
<a class="jxr_linenumber" name="L98" href="#L98">98</a>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment">/** RTS/CTS OUT flow control */</em>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> RTSCTS_OUT,
<a class="jxr_linenumber" name="L101" href="#L101">101</a>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/** RTS/CTS IN/OUT flow control */</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> RTSCTS_IN_OUT,
<a class="jxr_linenumber" name="L104" href="#L104">104</a>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment">/** XON/XOFF IN flow control */</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> XONXOFF_IN,
<a class="jxr_linenumber" name="L107" href="#L107">107</a>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment">/** XON/XOFF OUT flow control */</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> XONXOFF_OUT,
<a class="jxr_linenumber" name="L110" href="#L110">110</a>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment">/** XON/XOFF IN/OUT flow control */</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> XONXOFF_IN_OUT
<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
<a class="jxr_linenumber" name="L114" href="#L114">114</a>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String name;
<a class="jxr_linenumber" name="L116" href="#L116">116</a>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> bauds;
<a class="jxr_linenumber" name="L118" href="#L118">118</a>
<a class="jxr_linenumber" name="L119" href="#L119">119</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 class="jxr_linenumber" name="L120" href="#L120">120</a>
<a class="jxr_linenumber" name="L121" href="#L121">121</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 class="jxr_linenumber" name="L122" href="#L122">122</a>
<a class="jxr_linenumber" name="L123" href="#L123">123</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 class="jxr_linenumber" name="L124" href="#L124">124</a>
<a class="jxr_linenumber" name="L125" href="#L125">125</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 class="jxr_linenumber" name="L126" href="#L126">126</a>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * Create an address for a serial communication, associating a serial interface and</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * various serial signal carcteristics.</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * @param name name of the device, COM1 COM2 for Windows, /dev/ttyS0 for Unix</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * @param bauds baud rate for the communication</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * @param dataBits number of data bits per bytes</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @param stopBits number of stop bits</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @param parity parity used</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @param flowControl flow control used</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</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 href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">StopBits</a> stopBits, <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">Parity</a> parity,
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">FlowControl</a> flowControl) {
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"name"</span>);
<a class="jxr_linenumber" name="L141" href="#L141">141</a> }
<a class="jxr_linenumber" name="L142" href="#L142">142</a> name = name.trim();
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">if</strong> (name.length() == 0) {
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Empty name."</span>);
<a class="jxr_linenumber" name="L145" href="#L145">145</a> }
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">if</strong> (bauds &lt;= 0) {
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"bauds: "</span> + bauds);
<a class="jxr_linenumber" name="L148" href="#L148">148</a> }
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">if</strong> (dataBits == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"dataBits"</span>);
<a class="jxr_linenumber" name="L151" href="#L151">151</a> }
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">if</strong> (stopBits == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"stopBits"</span>);
<a class="jxr_linenumber" name="L154" href="#L154">154</a> }
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">if</strong> (parity == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"parity"</span>);
<a class="jxr_linenumber" name="L157" href="#L157">157</a> }
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">if</strong> (flowControl == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"flowControl"</span>);
<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
<a class="jxr_linenumber" name="L161" href="#L161">161</a>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">this</strong>.name = name;
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">this</strong>.bauds = bauds;
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">this</strong>.dataBits = dataBits;
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">this</strong>.stopBits = stopBits;
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">this</strong>.parity = parity;
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">this</strong>.flowControl = flowControl;
<a class="jxr_linenumber" name="L168" href="#L168">168</a> }
<a class="jxr_linenumber" name="L169" href="#L169">169</a>
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * Bauds rate for the communication.</em>
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * @return the bauds (bits per seconds) for this serial link</em>
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getBauds() {
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">return</strong> bauds;
<a class="jxr_linenumber" name="L176" href="#L176">176</a> }
<a class="jxr_linenumber" name="L177" href="#L177">177</a>
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * Number of data bits for each communicated bytes.</em>
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * @return the data bits</em>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">DataBits</a> getDataBits() {
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">return</strong> dataBits;
<a class="jxr_linenumber" name="L184" href="#L184">184</a> }
<a class="jxr_linenumber" name="L185" href="#L185">185</a>
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * The flow control policie used for this communication.</em>
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * @return the flow control</em>
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">FlowControl</a> getFlowControl() {
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">return</strong> flowControl;
<a class="jxr_linenumber" name="L192" href="#L192">192</a> }
<a class="jxr_linenumber" name="L193" href="#L193">193</a>
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * The name of the device. Can be COM1, COM2, /dev/ttyS0, /dev/ttyUSB1, etc..</em>
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * @return name</em>
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">public</strong> String getName() {
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">return</strong> name;
<a class="jxr_linenumber" name="L200" href="#L200">200</a> }
<a class="jxr_linenumber" name="L201" href="#L201">201</a>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * The parity check for this communication.</em>
<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * @return parity type</em>
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">Parity</a> getParity() {
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">return</strong> parity;
<a class="jxr_linenumber" name="L208" href="#L208">208</a> }
<a class="jxr_linenumber" name="L209" href="#L209">209</a>
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * Number of stop bits used.</em>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * @return stop bits number</em>
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/transport/serial/SerialAddress.html">StopBits</a> getStopBits() {
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">return</strong> stopBits;
<a class="jxr_linenumber" name="L216" href="#L216">216</a> }
<a class="jxr_linenumber" name="L217" href="#L217">217</a>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * Convert this serial address to a human readable string.</em>
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L221" href="#L221">221</a> @Override
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">return</strong> name + <span class="jxr_string">" (bauds: "</span> + bauds + <span class="jxr_string">", dataBits: "</span> + dataBits + <span class="jxr_string">", stopBits: "</span> + stopBits + <span class="jxr_string">", parity: "</span>
<a class="jxr_linenumber" name="L224" href="#L224">224</a> + parity + <span class="jxr_string">", flowControl: "</span> + flowControl + <span class="jxr_string">")"</span>;
<a class="jxr_linenumber" name="L225" href="#L225">225</a> }
<a class="jxr_linenumber" name="L226" href="#L226">226</a>
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">int</strong> getDataBitsForRXTX() {
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">switch</strong> (dataBits) {
<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">case</strong> DATABITS_5:
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">return</strong> SerialPort.DATABITS_5;
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">case</strong> DATABITS_6:
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">return</strong> SerialPort.DATABITS_6;
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">case</strong> DATABITS_7:
<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">return</strong> SerialPort.DATABITS_7;
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">case</strong> DATABITS_8:
<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">return</strong> SerialPort.DATABITS_8;
<a class="jxr_linenumber" name="L237" href="#L237">237</a> }
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> InvalidParameterException(<span class="jxr_string">"broken databits"</span>);
<a class="jxr_linenumber" name="L239" href="#L239">239</a> }
<a class="jxr_linenumber" name="L240" href="#L240">240</a>
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">int</strong> getStopBitsForRXTX() {
<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">switch</strong> (stopBits) {
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">case</strong> BITS_1:
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">return</strong> SerialPort.STOPBITS_1;
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">case</strong> BITS_1_5:
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">return</strong> SerialPort.STOPBITS_1_5;
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">case</strong> BITS_2:
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">return</strong> SerialPort.STOPBITS_2;
<a class="jxr_linenumber" name="L249" href="#L249">249</a> }
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> InvalidParameterException(<span class="jxr_string">"broken stopbits"</span>);
<a class="jxr_linenumber" name="L251" href="#L251">251</a> }
<a class="jxr_linenumber" name="L252" href="#L252">252</a>
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">int</strong> getParityForRXTX() {
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">switch</strong> (parity) {
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">case</strong> EVEN:
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">return</strong> SerialPort.PARITY_EVEN;
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">case</strong> MARK:
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">return</strong> SerialPort.PARITY_MARK;
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">case</strong> NONE:
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">return</strong> SerialPort.PARITY_NONE;
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong class="jxr_keyword">case</strong> ODD:
<a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">return</strong> SerialPort.PARITY_ODD;
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">case</strong> SPACE:
<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">return</strong> SerialPort.PARITY_SPACE;
<a class="jxr_linenumber" name="L265" href="#L265">265</a> }
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> InvalidParameterException(<span class="jxr_string">"broken parity"</span>);
<a class="jxr_linenumber" name="L267" href="#L267">267</a> }
<a class="jxr_linenumber" name="L268" href="#L268">268</a>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">int</strong> getFLowControlForRXTX() {
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong class="jxr_keyword">switch</strong> (flowControl) {
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">case</strong> NONE:
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">return</strong> SerialPort.FLOWCONTROL_NONE;
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">case</strong> RTSCTS_IN:
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">return</strong> SerialPort.FLOWCONTROL_RTSCTS_IN;
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">case</strong> RTSCTS_OUT:
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">return</strong> SerialPort.FLOWCONTROL_RTSCTS_OUT;
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">case</strong> RTSCTS_IN_OUT:
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">return</strong> SerialPort.FLOWCONTROL_RTSCTS_IN | SerialPort.FLOWCONTROL_RTSCTS_OUT;
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">case</strong> XONXOFF_IN:
<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">return</strong> SerialPort.FLOWCONTROL_XONXOFF_IN;
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">case</strong> XONXOFF_OUT:
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">return</strong> SerialPort.FLOWCONTROL_XONXOFF_OUT;
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">case</strong> XONXOFF_IN_OUT:
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">return</strong> SerialPort.FLOWCONTROL_XONXOFF_IN | SerialPort.FLOWCONTROL_XONXOFF_OUT;
<a class="jxr_linenumber" name="L285" href="#L285">285</a> }
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> InvalidParameterException(<span class="jxr_string">"broken flow control"</span>);
<a class="jxr_linenumber" name="L287" href="#L287">287</a> }
<a class="jxr_linenumber" name="L288" href="#L288">288</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2018 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</div>
</body>
</html>