Index (jfreesane API)

A C D F G I L M N O R S T U V W

A

acquireImage() - Method in class au.com.southsky.jfreesane.SaneDevice: Acquires a single image from the Sane daemon.
acquireImage(ScanListener) - Method in class au.com.southsky.jfreesane.SaneDevice: Acquires a single image from the Sane daemon.
au.com.southsky.jfreesane - package au.com.southsky.jfreesane: JFreeSane is a pure-Java implementation of a SANE client.

C

canAuthenticate(String) - Method in class au.com.southsky.jfreesane.SaneClientAuthentication: Returns true if the configuration contains an entry for the given resource.
canAuthenticate(String) - Method in class au.com.southsky.jfreesane.SanePasswordProvider: Returns true if this password provider is capable of providing authentication credentials for the given resource.
cancel() - Method in class au.com.southsky.jfreesane.SaneDevice: Cancel the current operation of a remote SANE device.
ClientCredential(String, String, String) - Constructor for class au.com.southsky.jfreesane.SaneClientAuthentication.ClientCredential
close() - Method in class au.com.southsky.jfreesane.SaneDevice: Closes the device.
close() - Method in class au.com.southsky.jfreesane.SaneSession: Closes the connection to the SANE server.

D

description() - Method in enum au.com.southsky.jfreesane.OptionValueConstraintType: Returns the description of the option as provided by the SANE backend.

F

fixedPrecisionValue() - Method in class au.com.southsky.jfreesane.SaneWord: Returns the value of this SaneWord treated as a SANE fixed precision value.
forFixedPrecision(double) - Static method in class au.com.southsky.jfreesane.SaneWord: Creates a new SaneWord from the given double.
forInt(int) - Static method in class au.com.southsky.jfreesane.SaneWord: Returns a new SaneWord representing the given integer value.
forSaneVersion(int, int, int) - Static method in class au.com.southsky.jfreesane.SaneWord: Returns a new SaneWord representing the given SANE version.
forUsernameAndPassword(String, String) - Static method in class au.com.southsky.jfreesane.SanePasswordProvider: Returns a SanePasswordProvider that returns the given username and password.
frameAcquisitionStarted(SaneDevice, SaneParameters, int, int) - Method in interface au.com.southsky.jfreesane.ScanListener: Called once frame acquisition has begun.
frameAcquisitionStarted(SaneDevice, SaneParameters, int, int) - Method in class au.com.southsky.jfreesane.ScanListenerAdapter
fromAuthString(String) - Static method in class au.com.southsky.jfreesane.SaneClientAuthentication.ClientCredential
fromBytes(byte[]) - Static method in class au.com.southsky.jfreesane.SaneWord: Creates a new SaneWord from a copy of the given byte array.
fromBytes(byte[], int) - Static method in class au.com.southsky.jfreesane.SaneWord: Creates a new SaneWord from a copy of the given bytes within the array.
fromStatusWord(SaneWord) - Static method in exception au.com.southsky.jfreesane.SaneException
fromStream(InputStream) - Static method in class au.com.southsky.jfreesane.SaneWord: Returns a new SaneWord by consuming SaneWord.SIZE_IN_BYTES bytes from the given InputStream.
fromWireValue(int) - Static method in enum au.com.southsky.jfreesane.SaneStatus: Returns the status represented by the given wire type, or null if the status is not known.
fromWireValue(SaneWord) - Static method in enum au.com.southsky.jfreesane.SaneStatus

G

getBackend() - Method in class au.com.southsky.jfreesane.SaneClientAuthentication.ClientCredential
getBooleanValue() - Method in class au.com.southsky.jfreesane.SaneOption: Reads the current boolean value option.
getConstraintType() - Method in class au.com.southsky.jfreesane.SaneOption
getCredentialForResource(String) - Method in class au.com.southsky.jfreesane.SaneClientAuthentication
getDescription() - Method in class au.com.southsky.jfreesane.SaneOption
getDevice() - Method in class au.com.southsky.jfreesane.SaneOption
getDevice(String) - Method in class au.com.southsky.jfreesane.SaneSession: Returns the device with the give name.
getFixedArrayValue() - Method in class au.com.southsky.jfreesane.SaneOption
getFixedValue() - Method in class au.com.southsky.jfreesane.SaneOption
getFixedValueListConstraint() - Method in class au.com.southsky.jfreesane.SaneOption
getGroup() - Method in class au.com.southsky.jfreesane.SaneOption
getIntegerArrayValue() - Method in class au.com.southsky.jfreesane.SaneOption
getIntegerValue() - Method in class au.com.southsky.jfreesane.SaneOption: Reads the current Integer value option.
getIntegerValueListConstraint() - Method in class au.com.southsky.jfreesane.SaneOption
getMaximumFixed() - Method in class au.com.southsky.jfreesane.RangeConstraint
getMaximumInteger() - Method in class au.com.southsky.jfreesane.RangeConstraint
getMinimumFixed() - Method in class au.com.southsky.jfreesane.RangeConstraint
getMinimumInteger() - Method in class au.com.southsky.jfreesane.RangeConstraint
getModel() - Method in class au.com.southsky.jfreesane.SaneDevice
getName() - Method in class au.com.southsky.jfreesane.SaneDevice
getName() - Method in class au.com.southsky.jfreesane.SaneOption
getOption(String) - Method in class au.com.southsky.jfreesane.SaneDevice: Returns the option with the given name for this device.
getOptionGroups() - Method in class au.com.southsky.jfreesane.SaneDevice: Returns the list of option groups for this device.
getOptions() - Method in class au.com.southsky.jfreesane.OptionGroup: Returns an immutable copy of the options in this group.
getPassword() - Method in class au.com.southsky.jfreesane.SaneClientAuthentication.ClientCredential
getPassword(String) - Method in class au.com.southsky.jfreesane.SaneClientAuthentication
getPassword(String) - Method in class au.com.southsky.jfreesane.SanePasswordProvider
getPasswordProvider() - Method in class au.com.southsky.jfreesane.SaneSession: Returns the current password provider.
getQuantumFixed() - Method in class au.com.southsky.jfreesane.RangeConstraint
getQuantumInteger() - Method in class au.com.southsky.jfreesane.RangeConstraint
getRangeConstraints() - Method in class au.com.southsky.jfreesane.SaneOption
getSize() - Method in class au.com.southsky.jfreesane.SaneOption
getStatus() - Method in exception au.com.southsky.jfreesane.SaneException: Returns the reason that this exception was thrown, or null if none is known.
getStringConstraints() - Method in class au.com.southsky.jfreesane.SaneOption
getStringValue() - Method in class au.com.southsky.jfreesane.SaneOption: Returns the value of this option interpreted as a LATIN-1 (SANE's default encoding) encoded string.
getStringValue(Charset) - Method in class au.com.southsky.jfreesane.SaneOption
getTitle() - Method in class au.com.southsky.jfreesane.OptionGroup
getTitle() - Method in class au.com.southsky.jfreesane.SaneOption
getType() - Method in class au.com.southsky.jfreesane.SaneDevice
getType() - Method in class au.com.southsky.jfreesane.SaneOption
getUnits() - Method in class au.com.southsky.jfreesane.SaneOption
getUsername() - Method in class au.com.southsky.jfreesane.SaneClientAuthentication.ClientCredential
getUsername(String) - Method in class au.com.southsky.jfreesane.SaneClientAuthentication
getUsername(String) - Method in class au.com.southsky.jfreesane.SanePasswordProvider
getValue() - Method in class au.com.southsky.jfreesane.SaneWord: Returns a copy of the underlying byte array representing this SaneWord.
getValueCount() - Method in class au.com.southsky.jfreesane.SaneOption
getValueType() - Method in class au.com.southsky.jfreesane.OptionGroup
getVendor() - Method in class au.com.southsky.jfreesane.SaneDevice
getWireValue() - Method in enum au.com.southsky.jfreesane.OptionValueConstraintType
getWireValue() - Method in enum au.com.southsky.jfreesane.OptionValueType
getWireValue() - Method in enum au.com.southsky.jfreesane.SaneOption.OptionUnits
getWireValue() - Method in enum au.com.southsky.jfreesane.SaneOption.OptionWriteInfo
getWireValue() - Method in enum au.com.southsky.jfreesane.SaneStatus
getWordConstraints() - Method in class au.com.southsky.jfreesane.SaneOption

I

integerValue() - Method in class au.com.southsky.jfreesane.SaneWord: Treats this SaneWord as an integer and returns the represented value.
isActive() - Method in class au.com.southsky.jfreesane.SaneOption
isConstrained() - Method in class au.com.southsky.jfreesane.SaneOption: Returns true if this option has a constraint other than OptionValueConstraintType.NO_CONSTRAINT.
isOpen() - Method in class au.com.southsky.jfreesane.SaneDevice: Returns true if the device is open.
isReadable() - Method in class au.com.southsky.jfreesane.SaneOption
isWriteable() - Method in class au.com.southsky.jfreesane.SaneOption

L

listDevices() - Method in class au.com.southsky.jfreesane.SaneSession: Lists the devices known to the SANE daemon.
listOptions() - Method in class au.com.southsky.jfreesane.SaneDevice: Returns the list of options applicable to this device.

M

MARKER_MD5 - Static variable in class au.com.southsky.jfreesane.SaneClientAuthentication

N

noMoreFrequentlyThan(ScanListener, long, TimeUnit) - Static method in class au.com.southsky.jfreesane.RateLimitingScanListeners: Returns ScanListener that calls the given listener ScanListener.recordRead(au.com.southsky.jfreesane.SaneDevice, int, int) method no more frequently than the given time any one device.

O

open() - Method in class au.com.southsky.jfreesane.SaneDevice: Opens the device.
OptionGroup - Class in au.com.southsky.jfreesane: Represents a group of options.
OptionGroup(String) - Constructor for class au.com.southsky.jfreesane.OptionGroup
OptionValueConstraintType - Enum in au.com.southsky.jfreesane: Represents the types of constraints that a SaneOption may be subjected to.
OptionValueType - Enum in au.com.southsky.jfreesane: Instances of this enum are returned by SaneOption.getType() that indicate the type of value that the option has.

R

RangeConstraint - Class in au.com.southsky.jfreesane: Represents a restriction on the acceptable values of an option.
RateLimitingScanListeners - Class in au.com.southsky.jfreesane: A static factory of listeners that limit the rate at which they send ScanListener.recordRead(au.com.southsky.jfreesane.SaneDevice, int, int) notifications.
recordRead(SaneDevice, int, int) - Method in interface au.com.southsky.jfreesane.ScanListener: Called once for each record in a frame.
recordRead(SaneDevice, int, int) - Method in class au.com.southsky.jfreesane.ScanListenerAdapter

S

SaneClientAuthentication - Class in au.com.southsky.jfreesane: Represents the authentication configuration used by SANE clients.
SaneClientAuthentication() - Constructor for class au.com.southsky.jfreesane.SaneClientAuthentication
SaneClientAuthentication(String) - Constructor for class au.com.southsky.jfreesane.SaneClientAuthentication
SaneClientAuthentication(CharSource) - Constructor for class au.com.southsky.jfreesane.SaneClientAuthentication: Returns a new SaneClientAuthentication whose configuration is represented by the characters supplied by the given CharSource.
SaneClientAuthentication.ClientCredential - Class in au.com.southsky.jfreesane: Class to hold Sane client credentials organised by backend.
SaneDevice - Class in au.com.southsky.jfreesane: Represents a SANE device within a session.
SaneException - Exception in au.com.southsky.jfreesane: Represents an application level exception thrown by Sane.
SaneException(SaneStatus) - Constructor for exception au.com.southsky.jfreesane.SaneException
SaneException(String) - Constructor for exception au.com.southsky.jfreesane.SaneException
SaneOption - Class in au.com.southsky.jfreesane: This class represents a SANE device option.
SaneOption.OptionUnits - Enum in au.com.southsky.jfreesane: Instances of this enum are returned by SaneOption.getUnits() indicating what units, if any, the value has.
SaneOption.OptionWriteInfo - Enum in au.com.southsky.jfreesane: Represents the information that the SANE daemon returns about the effect of modifying an option.
SanePasswordProvider - Class in au.com.southsky.jfreesane: Implements a provider of SANE resource credentials.
SanePasswordProvider() - Constructor for class au.com.southsky.jfreesane.SanePasswordProvider
SaneSession - Class in au.com.southsky.jfreesane: Represents a conversation taking place with a SANE daemon.
SaneStatus - Enum in au.com.southsky.jfreesane: Represents the status codes that can be returned by the Sane backend.
SaneWord - Class in au.com.southsky.jfreesane: Represents a SANE word type.
ScanListener - Interface in au.com.southsky.jfreesane: Implementations of this interface can receive notifications when certain events happen during a page scan.
ScanListenerAdapter - Class in au.com.southsky.jfreesane: A no-op implementation of ScanListener.
ScanListenerAdapter() - Constructor for class au.com.southsky.jfreesane.ScanListenerAdapter
scanningFinished(SaneDevice) - Method in interface au.com.southsky.jfreesane.ScanListener: Called once the current page is done.
scanningFinished(SaneDevice) - Method in class au.com.southsky.jfreesane.ScanListenerAdapter
scanningStarted(SaneDevice) - Method in interface au.com.southsky.jfreesane.ScanListener: Called once scanning has begun.
scanningStarted(SaneDevice) - Method in class au.com.southsky.jfreesane.ScanListenerAdapter
setBooleanValue(boolean) - Method in class au.com.southsky.jfreesane.SaneOption: Sets the value of the current option to the supplied boolean value.
setButtonValue() - Method in class au.com.southsky.jfreesane.SaneOption
setFixedValue(double) - Method in class au.com.southsky.jfreesane.SaneOption: Sets the value of the current option to the supplied fixed-precision value.
setFixedValue(List<Double>) - Method in class au.com.southsky.jfreesane.SaneOption: Sets the value of the current option to the supplied list of fixed-precision values.
setIntegerValue(int) - Method in class au.com.southsky.jfreesane.SaneOption: Set the value of the current option to the supplied value.
setIntegerValue(List<Integer>) - Method in class au.com.southsky.jfreesane.SaneOption
setPasswordProvider(SanePasswordProvider) - Method in class au.com.southsky.jfreesane.SaneSession: Sets the password provider to use if the SANE daemon asks for credentials when accessing a resource.
setStringValue(String) - Method in class au.com.southsky.jfreesane.SaneOption
SIZE_IN_BYTES - Static variable in class au.com.southsky.jfreesane.SaneWord: The number of bytes used to represent a SANE word.

T

TO_FIXED_FUNCTION - Static variable in class au.com.southsky.jfreesane.SaneWord: A function that, when applied to a SaneWord instance, returns the SANE fixed precision value of that SANE word.
TO_INTEGER_FUNCTION - Static variable in class au.com.southsky.jfreesane.SaneWord: A function that, when applied to a SaneWord instance, returns the integer value of that SANE word.
toString() - Method in class au.com.southsky.jfreesane.OptionGroup
toString() - Method in class au.com.southsky.jfreesane.SaneDevice
toString() - Method in class au.com.southsky.jfreesane.SaneOption
toString() - Method in class au.com.southsky.jfreesane.SaneWord

U

usingDotSanePassFile() - Static method in class au.com.southsky.jfreesane.SanePasswordProvider: Returns a password provider that uses the ~/.sane/pass file to determine resource credentials.
usingSanePassFile(String) - Static method in class au.com.southsky.jfreesane.SanePasswordProvider: Returns a password provider that uses the given file in SANE password file format.

V

valueOf(String) - Static method in enum au.com.southsky.jfreesane.OptionValueConstraintType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum au.com.southsky.jfreesane.OptionValueType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum au.com.southsky.jfreesane.SaneOption.OptionUnits: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum au.com.southsky.jfreesane.SaneOption.OptionWriteInfo: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum au.com.southsky.jfreesane.SaneStatus: Returns the enum constant of this type with the specified name.
values() - Static method in enum au.com.southsky.jfreesane.OptionValueConstraintType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum au.com.southsky.jfreesane.OptionValueType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum au.com.southsky.jfreesane.SaneOption.OptionUnits: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum au.com.southsky.jfreesane.SaneOption.OptionWriteInfo: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum au.com.southsky.jfreesane.SaneStatus: Returns an array containing the constants of this enum type, in the order they are declared.

W

withRemoteSane(InetAddress) - Static method in class au.com.southsky.jfreesane.SaneSession: Establishes a connection to the SANE daemon running on the given host on the default SANE port with no connection timeout.
withRemoteSane(InetAddress, long, TimeUnit) - Static method in class au.com.southsky.jfreesane.SaneSession: Establishes a connection to the SANE daemon running on the given host on the default SANE port with the given connection timeout.
withRemoteSane(InetAddress, int) - Static method in class au.com.southsky.jfreesane.SaneSession: Establishes a connection to the SANE daemon running on the given host on the given port with no connection timeout.
withRemoteSane(InetAddress, int, long, TimeUnit) - Static method in class au.com.southsky.jfreesane.SaneSession: Establishes a connection to the SANE daemon running on the given host on the given port.

A C D F G I L M N O R S T U V W