Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 2.0.11 / apidocs / src-html / org / apache / mina / transport / serial / SerialAddress.DataBits.html
blob: bdc923443385f84ef40f11404fb6a0f32759b8e0 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> */<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>package org.apache.mina.transport.serial;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import gnu.io.SerialPort;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.net.SocketAddress;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.security.InvalidParameterException;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * An address for a serial port communication.<a name="line.29"></a>
<span class="sourceLineNo">030</span> *<a name="line.30"></a>
<span class="sourceLineNo">031</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span>public class SerialAddress extends SocketAddress {<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span> private static final long serialVersionUID = 1735370510442384505L;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> public enum DataBits {<a name="line.37"></a>
<span class="sourceLineNo">038</span> DATABITS_5, DATABITS_6, DATABITS_7, DATABITS_8<a name="line.38"></a>
<span class="sourceLineNo">039</span> }<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> public enum Parity {<a name="line.41"></a>
<span class="sourceLineNo">042</span> NONE, ODD, EVEN, MARK, SPACE<a name="line.42"></a>
<span class="sourceLineNo">043</span> }<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> public enum StopBits {<a name="line.45"></a>
<span class="sourceLineNo">046</span> BITS_1, BITS_2, BITS_1_5<a name="line.46"></a>
<span class="sourceLineNo">047</span> }<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> public enum FlowControl {<a name="line.49"></a>
<span class="sourceLineNo">050</span> NONE, RTSCTS_IN, RTSCTS_OUT, RTSCTS_IN_OUT, XONXOFF_IN, XONXOFF_OUT, XONXOFF_IN_OUT<a name="line.50"></a>
<span class="sourceLineNo">051</span> }<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> private final String name;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> private final int bauds;<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> private final DataBits dataBits;<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> private final StopBits stopBits;<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> private final Parity parity;<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> private final FlowControl flowControl;<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> /**<a name="line.65"></a>
<span class="sourceLineNo">066</span> * Create an address for a serial communication, associating a serial interface and<a name="line.66"></a>
<span class="sourceLineNo">067</span> * various serial signal carcteristics.<a name="line.67"></a>
<span class="sourceLineNo">068</span> * @param name name of the device, COM1 COM2 for Windows, /dev/ttyS0 for Unix<a name="line.68"></a>
<span class="sourceLineNo">069</span> * @param bauds baud rate for the communication<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @param dataBits number of data bits per bytes<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @param stopBits number of stop bits<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @param parity parity used<a name="line.72"></a>
<span class="sourceLineNo">073</span> * @param flowControl flow control used<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> public SerialAddress(String name, int bauds, DataBits dataBits, StopBits stopBits, Parity parity,<a name="line.75"></a>
<span class="sourceLineNo">076</span> FlowControl flowControl) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> if (name == null) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> throw new IllegalArgumentException("name");<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span> name = name.trim();<a name="line.80"></a>
<span class="sourceLineNo">081</span> if (name.length() == 0) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> throw new IllegalArgumentException("Empty name.");<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span> if (bauds &lt;= 0) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> throw new IllegalArgumentException("bauds: " + bauds);<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span> if (dataBits == null) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> throw new IllegalArgumentException("dataBits");<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span> if (stopBits == null) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> throw new IllegalArgumentException("stopBits");<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> if (parity == null) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> throw new IllegalArgumentException("parity");<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span> if (flowControl == null) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> throw new IllegalArgumentException("flowControl");<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> this.name = name;<a name="line.100"></a>
<span class="sourceLineNo">101</span> this.bauds = bauds;<a name="line.101"></a>
<span class="sourceLineNo">102</span> this.dataBits = dataBits;<a name="line.102"></a>
<span class="sourceLineNo">103</span> this.stopBits = stopBits;<a name="line.103"></a>
<span class="sourceLineNo">104</span> this.parity = parity;<a name="line.104"></a>
<span class="sourceLineNo">105</span> this.flowControl = flowControl;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> /**<a name="line.108"></a>
<span class="sourceLineNo">109</span> * Bauds rate for the communication.<a name="line.109"></a>
<span class="sourceLineNo">110</span> * @return the bauds (bits per seconds) for this serial link<a name="line.110"></a>
<span class="sourceLineNo">111</span> */<a name="line.111"></a>
<span class="sourceLineNo">112</span> public int getBauds() {<a name="line.112"></a>
<span class="sourceLineNo">113</span> return bauds;<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> /**<a name="line.116"></a>
<span class="sourceLineNo">117</span> * Number of data bits for each communicated bytes.<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @return the data bits<a name="line.118"></a>
<span class="sourceLineNo">119</span> */<a name="line.119"></a>
<span class="sourceLineNo">120</span> public DataBits getDataBits() {<a name="line.120"></a>
<span class="sourceLineNo">121</span> return dataBits;<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
<span class="sourceLineNo">125</span> * The flow control policie used for this communication.<a name="line.125"></a>
<span class="sourceLineNo">126</span> * @return the flow control<a name="line.126"></a>
<span class="sourceLineNo">127</span> */<a name="line.127"></a>
<span class="sourceLineNo">128</span> public FlowControl getFlowControl() {<a name="line.128"></a>
<span class="sourceLineNo">129</span> return flowControl;<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> /**<a name="line.132"></a>
<span class="sourceLineNo">133</span> * The name of the device. Can be COM1, COM2, /dev/ttyS0, /dev/ttyUSB1, etc..<a name="line.133"></a>
<span class="sourceLineNo">134</span> * @return name<a name="line.134"></a>
<span class="sourceLineNo">135</span> */<a name="line.135"></a>
<span class="sourceLineNo">136</span> public String getName() {<a name="line.136"></a>
<span class="sourceLineNo">137</span> return name;<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span> /**<a name="line.140"></a>
<span class="sourceLineNo">141</span> * The parity check for this communication.<a name="line.141"></a>
<span class="sourceLineNo">142</span> * @return parity type<a name="line.142"></a>
<span class="sourceLineNo">143</span> */<a name="line.143"></a>
<span class="sourceLineNo">144</span> public Parity getParity() {<a name="line.144"></a>
<span class="sourceLineNo">145</span> return parity;<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> /**<a name="line.148"></a>
<span class="sourceLineNo">149</span> * Number of stop bits used.<a name="line.149"></a>
<span class="sourceLineNo">150</span> * @return stop bits number<a name="line.150"></a>
<span class="sourceLineNo">151</span> */<a name="line.151"></a>
<span class="sourceLineNo">152</span> public StopBits getStopBits() {<a name="line.152"></a>
<span class="sourceLineNo">153</span> return stopBits;<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> /**<a name="line.156"></a>
<span class="sourceLineNo">157</span> * Convert this serial address to a human readable string.<a name="line.157"></a>
<span class="sourceLineNo">158</span> */<a name="line.158"></a>
<span class="sourceLineNo">159</span> @Override<a name="line.159"></a>
<span class="sourceLineNo">160</span> public String toString() {<a name="line.160"></a>
<span class="sourceLineNo">161</span> return name + " (bauds: " + bauds + ", dataBits: " + dataBits + ", stopBits: " + stopBits + ", parity: "<a name="line.161"></a>
<span class="sourceLineNo">162</span> + parity + ", flowControl: " + flowControl + ")";<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> int getDataBitsForRXTX() {<a name="line.165"></a>
<span class="sourceLineNo">166</span> switch (dataBits) {<a name="line.166"></a>
<span class="sourceLineNo">167</span> case DATABITS_5:<a name="line.167"></a>
<span class="sourceLineNo">168</span> return SerialPort.DATABITS_5;<a name="line.168"></a>
<span class="sourceLineNo">169</span> case DATABITS_6:<a name="line.169"></a>
<span class="sourceLineNo">170</span> return SerialPort.DATABITS_6;<a name="line.170"></a>
<span class="sourceLineNo">171</span> case DATABITS_7:<a name="line.171"></a>
<span class="sourceLineNo">172</span> return SerialPort.DATABITS_7;<a name="line.172"></a>
<span class="sourceLineNo">173</span> case DATABITS_8:<a name="line.173"></a>
<span class="sourceLineNo">174</span> return SerialPort.DATABITS_8;<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span> throw new InvalidParameterException("broken databits");<a name="line.176"></a>
<span class="sourceLineNo">177</span> }<a name="line.177"></a>
<span class="sourceLineNo">178</span><a name="line.178"></a>
<span class="sourceLineNo">179</span> int getStopBitsForRXTX() {<a name="line.179"></a>
<span class="sourceLineNo">180</span> switch (stopBits) {<a name="line.180"></a>
<span class="sourceLineNo">181</span> case BITS_1:<a name="line.181"></a>
<span class="sourceLineNo">182</span> return SerialPort.STOPBITS_1;<a name="line.182"></a>
<span class="sourceLineNo">183</span> case BITS_1_5:<a name="line.183"></a>
<span class="sourceLineNo">184</span> return SerialPort.STOPBITS_1_5;<a name="line.184"></a>
<span class="sourceLineNo">185</span> case BITS_2:<a name="line.185"></a>
<span class="sourceLineNo">186</span> return SerialPort.STOPBITS_2;<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span> throw new InvalidParameterException("broken stopbits");<a name="line.188"></a>
<span class="sourceLineNo">189</span> }<a name="line.189"></a>
<span class="sourceLineNo">190</span><a name="line.190"></a>
<span class="sourceLineNo">191</span> int getParityForRXTX() {<a name="line.191"></a>
<span class="sourceLineNo">192</span> switch (parity) {<a name="line.192"></a>
<span class="sourceLineNo">193</span> case EVEN:<a name="line.193"></a>
<span class="sourceLineNo">194</span> return SerialPort.PARITY_EVEN;<a name="line.194"></a>
<span class="sourceLineNo">195</span> case MARK:<a name="line.195"></a>
<span class="sourceLineNo">196</span> return SerialPort.PARITY_MARK;<a name="line.196"></a>
<span class="sourceLineNo">197</span> case NONE:<a name="line.197"></a>
<span class="sourceLineNo">198</span> return SerialPort.PARITY_NONE;<a name="line.198"></a>
<span class="sourceLineNo">199</span> case ODD:<a name="line.199"></a>
<span class="sourceLineNo">200</span> return SerialPort.PARITY_ODD;<a name="line.200"></a>
<span class="sourceLineNo">201</span> case SPACE:<a name="line.201"></a>
<span class="sourceLineNo">202</span> return SerialPort.PARITY_SPACE;<a name="line.202"></a>
<span class="sourceLineNo">203</span> }<a name="line.203"></a>
<span class="sourceLineNo">204</span> throw new InvalidParameterException("broken parity");<a name="line.204"></a>
<span class="sourceLineNo">205</span> }<a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>
<span class="sourceLineNo">207</span> int getFLowControlForRXTX() {<a name="line.207"></a>
<span class="sourceLineNo">208</span> switch (flowControl) {<a name="line.208"></a>
<span class="sourceLineNo">209</span> case NONE:<a name="line.209"></a>
<span class="sourceLineNo">210</span> return SerialPort.FLOWCONTROL_NONE;<a name="line.210"></a>
<span class="sourceLineNo">211</span> case RTSCTS_IN:<a name="line.211"></a>
<span class="sourceLineNo">212</span> return SerialPort.FLOWCONTROL_RTSCTS_IN;<a name="line.212"></a>
<span class="sourceLineNo">213</span> case RTSCTS_OUT:<a name="line.213"></a>
<span class="sourceLineNo">214</span> return SerialPort.FLOWCONTROL_RTSCTS_OUT;<a name="line.214"></a>
<span class="sourceLineNo">215</span> case RTSCTS_IN_OUT:<a name="line.215"></a>
<span class="sourceLineNo">216</span> return SerialPort.FLOWCONTROL_RTSCTS_IN | SerialPort.FLOWCONTROL_RTSCTS_OUT;<a name="line.216"></a>
<span class="sourceLineNo">217</span> case XONXOFF_IN:<a name="line.217"></a>
<span class="sourceLineNo">218</span> return SerialPort.FLOWCONTROL_XONXOFF_IN;<a name="line.218"></a>
<span class="sourceLineNo">219</span> case XONXOFF_OUT:<a name="line.219"></a>
<span class="sourceLineNo">220</span> return SerialPort.FLOWCONTROL_XONXOFF_OUT;<a name="line.220"></a>
<span class="sourceLineNo">221</span> case XONXOFF_IN_OUT:<a name="line.221"></a>
<span class="sourceLineNo">222</span> return SerialPort.FLOWCONTROL_XONXOFF_IN | SerialPort.FLOWCONTROL_XONXOFF_OUT;<a name="line.222"></a>
<span class="sourceLineNo">223</span> }<a name="line.223"></a>
<span class="sourceLineNo">224</span> throw new InvalidParameterException("broken flow control");<a name="line.224"></a>
<span class="sourceLineNo">225</span> }<a name="line.225"></a>
<span class="sourceLineNo">226</span>}<a name="line.226"></a>
</pre>
</div>
</body>
</html>