net.sf.atmodem4j.spsw

Class SerialPortList

java.lang.Object

net.sf.atmodem4j.spsw.SerialPortList

public class SerialPortList
extends Object

Author:

scream3r

Constructor Summary

Constructors

Constructor and Description
SerialPortList()

Method Summary

Modifier and Type	Method and Description
static Set<String>	getPortNames(boolean hideBusyPorts) Get sorted array of serial ports in the system using default settings: Search path Windows - ""(always ignored) Linux - "/dev/" Solaris - "/dev/term/" MacOSX - "/dev/" RegExp Windows - "" Linux - "(ttyS|ttyUSB|ttyACM|ttyAMA|rfcomm)[0-9]{1,3}" Solaris - "[0-9]*|[a-z]*" MacOSX - "tty.
static Set<String>	getPortNames(Comparator<String> comparator, boolean hideBusyPorts) Get sorted array of serial ports in the system matched pattern
static Set<String>	getPortNames(Pattern pattern, boolean hideBusyPorts) Get sorted array of serial ports in the system matched pattern
static Set<String>	getPortNames(Pattern pattern, Comparator<String> comparator, boolean hideBusyPorts) Get sorted array of serial ports in the system matched pattern and sorted by comparator
static Set<String>	getPortNames(String searchPath, boolean hideBusyPorts) Get sorted array of serial ports in the system located on searchPath
static Set<String>	getPortNames(String searchPath, Comparator<String> comparator, boolean hideBusyPorts) Get sorted array of serial ports in the system located on searchPath and sorted by comparator
static Set<String>	getPortNames(String searchPath, Pattern pattern, boolean hideBusyPorts) Get sorted array of serial ports in the system located on searchPath, matched pattern
static Set<String>	getPortNames(String searchPath, Pattern pattern, Comparator<String> comparator, boolean hideBusyPorts) Get sorted array of serial ports in the system located on searchPath, matched pattern and sorted by comparator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SerialPortList

public SerialPortList()

Method Detail

getPortNames

public static Set<String> getPortNames(boolean hideBusyPorts)

Get sorted array of serial ports in the system using default settings:
Search path
Windows - ""(always ignored)
Linux - "/dev/"
Solaris - "/dev/term/"
MacOSX - "/dev/"
RegExp
Windows - ""
Linux - "(ttyS|ttyUSB|ttyACM|ttyAMA|rfcomm)[0-9]{1,3}"
Solaris - "[0-9]*|[a-z]*"
MacOSX - "tty.(serial|usbserial|usbmodem).*"

Returns:

String array. If there is no ports in the system String[] with zero length will be returned (since jSSC-0.8 in previous versions null will be returned)

getPortNames

public static Set<String> getPortNames(String searchPath,
                                       boolean hideBusyPorts)

Get sorted array of serial ports in the system located on searchPath

Parameters:

searchPath - Path for searching serial ports (not null)
The default search paths:
Linux, MacOSX: /dev/
Solaris: /dev/term/
Windows: this parameter ingored

Returns:

String array. If there is no ports in the system String[]

Since:

2.3.0

getPortNames

public static Set<String> getPortNames(Pattern pattern,
                                       boolean hideBusyPorts)

Get sorted array of serial ports in the system matched pattern

Parameters:

pattern - RegExp pattern for matching port names (not null)

Returns:

String array. If there is no ports in the system String[]

Since:

2.3.0

getPortNames

public static Set<String> getPortNames(Comparator<String> comparator,
                                       boolean hideBusyPorts)

Get sorted array of serial ports in the system matched pattern

Parameters:

comparator - Comparator for sotring port names (not null)

Returns:

String array. If there is no ports in the system String[]

Since:

2.3.0

getPortNames

public static Set<String> getPortNames(String searchPath,
                                       Pattern pattern,
                                       boolean hideBusyPorts)

Get sorted array of serial ports in the system located on searchPath, matched pattern

Parameters:

searchPath - Path for searching serial ports (not null)
The default search paths:
Linux, MacOSX: /dev/
Solaris: /dev/term/
Windows: this parameter ingored

pattern - RegExp pattern for matching port names (not null)

Returns:

String array. If there is no ports in the system String[]

Since:

2.3.0

getPortNames

public static Set<String> getPortNames(String searchPath,
                                       Comparator<String> comparator,
                                       boolean hideBusyPorts)

Get sorted array of serial ports in the system located on searchPath and sorted by comparator

Parameters:

searchPath - Path for searching serial ports (not null)
The default search paths:
Linux, MacOSX: /dev/
Solaris: /dev/term/
Windows: this parameter ingored

comparator - Comparator for sotring port names (not null)

Returns:

String array. If there is no ports in the system String[]

Since:

2.3.0

getPortNames

public static Set<String> getPortNames(Pattern pattern,
                                       Comparator<String> comparator,
                                       boolean hideBusyPorts)

Get sorted array of serial ports in the system matched pattern and sorted by comparator

Parameters:

pattern - RegExp pattern for matching port names (not null)

comparator - Comparator for sotring port names (not null)

Returns:

String array. If there is no ports in the system String[]

Since:

2.3.0

getPortNames

public static Set<String> getPortNames(String searchPath,
                                       Pattern pattern,
                                       Comparator<String> comparator,
                                       boolean hideBusyPorts)

Get sorted array of serial ports in the system located on searchPath, matched pattern and sorted by comparator

Parameters:

searchPath - Path for searching serial ports (not null)
The default search paths:
Linux, MacOSX: /dev/
Solaris: /dev/term/
Windows: this parameter ingored

pattern - RegExp pattern for matching port names (not null)

comparator - Comparator for sotring port names (not null)

hideBusyPorts -

Returns:

String array. If there is no ports in the system String[]

Since:

2.3.0