au.com.southsky.jfreesane

Class SaneDevice

java.lang.Object

au.com.southsky.jfreesane.SaneDevice

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class SaneDevice
extends java.lang.Object
implements java.io.Closeable

Represents a SANE device within a session. SANE devices are obtained from a SaneSession.

Definitely not thread-safe. If you're going to use this object from multiple threads, you must do your own synchronization. Even performing read operations (like getting an option's value) must be synchronized.

Method Summary

Modifier and Type	Method and Description
java.awt.image.BufferedImage	acquireImage() Acquires a single image from the Sane daemon.
java.awt.image.BufferedImage	acquireImage(ScanListener listener) Acquires a single image from the Sane daemon.
void	cancel() Cancel the current operation of a remote SANE device.
void	close() Closes the device.
java.lang.String	getModel()
java.lang.String	getName()
SaneOption	getOption(java.lang.String title) Returns the option with the given name for this device.
java.util.List<OptionGroup>	getOptionGroups() Returns the list of option groups for this device.
java.lang.String	getType()
java.lang.String	getVendor()
boolean	isOpen() Returns true if the device is open.
java.util.List<SaneOption>	listOptions() Returns the list of options applicable to this device.
void	open() Opens the device.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

getVendor

public java.lang.String getVendor()

getModel

public java.lang.String getModel()

getType

public java.lang.String getType()

isOpen

public boolean isOpen()

Returns true if the device is open.

open

public void open()
          throws java.io.IOException,
                 SaneException

Opens the device.

Throws:

java.io.IOException - if a problem occurred while talking to SANE

SaneException

java.lang.IllegalStateException - if the device is already open

acquireImage

public java.awt.image.BufferedImage acquireImage()
                                          throws java.io.IOException,
                                                 SaneException

Acquires a single image from the Sane daemon.

Returns:

a BufferedImage representing the image obtained from Sane

Throws:

java.io.IOException - if an error occurred while talking to the backend

SaneException - if an application-level error was returned by the Sane daemon

acquireImage

public java.awt.image.BufferedImage acquireImage(ScanListener listener)
                                          throws java.io.IOException,
                                                 SaneException

Acquires a single image from the Sane daemon. The given ScanListener will be notified about updates during the scan.

The scanning thread will be used to make calls to listener. Scanning will not proceed until control returns to JFreeSane, so your implementation should not monopolize this thread for longer than necessary.

Parameters:

listener - if not null, this object will receive notifications about scan progress

Returns:

a BufferedImage representing the image obtained from Sane

Throws:

java.io.IOException - if an error occurred while talking to the backend

SaneException - if an application-level error was returned by the Sane daemon

cancel

public void cancel()
            throws java.io.IOException

Cancel the current operation of a remote SANE device.

Throws:

java.io.IOException - if an error occurs talking to the SANE backend

java.lang.IllegalStateException - if the device is not open

close

public void close()
           throws java.io.IOException

Closes the device.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if an error occurs talking to the SANE backend

java.lang.IllegalStateException - if the device is already closed

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

listOptions

public java.util.List<SaneOption> listOptions()
                                       throws java.io.IOException

Returns the list of options applicable to this device.

Returns:

a list of SaneOption instances

Throws:

java.io.IOException - if a problem occurred talking to the SANE backend

getOptionGroups

public java.util.List<OptionGroup> getOptionGroups()
                                            throws java.io.IOException

Returns the list of option groups for this device.

Throws:

java.io.IOException

getOption

public SaneOption getOption(java.lang.String title)
                     throws java.io.IOException

Returns the option with the given name for this device. If the option does not exist, null is returned. Name matching is case-sensitive.

Throws:

java.io.IOException