au.com.southsky.jfreesane

Class SaneOption

java.lang.Object

au.com.southsky.jfreesane.SaneOption

public final class SaneOption
extends java.lang.Object

This class represents a SANE device option. An option may be active or inactive (see isActive()). Active options may be read (see isReadable()) and modified (see isWriteable()).

Options have a type (see getType()), in order to read or write an option's value, you must call the getter or setter method corresponding to the option's type. For example, for an option of type OptionValueType.STRING, you will call setStringValue(java.lang.String) or getStringValue().

Options may have constraints that impose restrictions on the range of values the option may take. Constraints have a type which may be obtained using getConstraintType(). You may read the actual constraints by calling the constraint getter method corresponding to the constraint type. For example, an option of type OptionValueType.INT may have a constraint of type OptionValueConstraintType.VALUE_LIST_CONSTRAINT, which you may obtain by calling getIntegerValueListConstraint().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SaneOption.OptionUnits Instances of this enum are returned by getUnits() indicating what units, if any, the value has.
static class	SaneOption.OptionWriteInfo Represents the information that the SANE daemon returns about the effect of modifying an option.

Method Summary

Modifier and Type	Method and Description
boolean	getBooleanValue() Reads the current boolean value option.
OptionValueConstraintType	getConstraintType()
java.lang.String	getDescription()
SaneDevice	getDevice()
java.util.List<java.lang.Double>	getFixedArrayValue()
double	getFixedValue()
java.util.List<java.lang.Double>	getFixedValueListConstraint()
OptionGroup	getGroup()
java.util.List<java.lang.Integer>	getIntegerArrayValue()
int	getIntegerValue() Reads the current Integer value option.
java.util.List<java.lang.Integer>	getIntegerValueListConstraint()
java.lang.String	getName()
RangeConstraint	getRangeConstraints()
int	getSize()
java.util.List<java.lang.String>	getStringConstraints()
java.lang.String	getStringValue() Returns the value of this option interpreted as a LATIN-1 (SANE's default encoding) encoded string.
java.lang.String	getStringValue(java.nio.charset.Charset encoding)
java.lang.String	getTitle()
OptionValueType	getType()
SaneOption.OptionUnits	getUnits()
int	getValueCount()
java.util.List<SaneWord>	getWordConstraints()
boolean	isActive()
boolean	isConstrained() Returns true if this option has a constraint other than OptionValueConstraintType.NO_CONSTRAINT.
boolean	isReadable()
boolean	isWriteable()
boolean	setBooleanValue(boolean value) Sets the value of the current option to the supplied boolean value.
void	setButtonValue()
double	setFixedValue(double value) Sets the value of the current option to the supplied fixed-precision value.
java.util.List<java.lang.Double>	setFixedValue(java.util.List<java.lang.Double> value) Sets the value of the current option to the supplied list of fixed-precision values.
int	setIntegerValue(int newValue) Set the value of the current option to the supplied value.
java.util.List<java.lang.Integer>	setIntegerValue(java.util.List<java.lang.Integer> newValue)
java.lang.String	setStringValue(java.lang.String newValue)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getDevice

public SaneDevice getDevice()

getName

public java.lang.String getName()

getTitle

public java.lang.String getTitle()

getDescription

public java.lang.String getDescription()

getGroup

public OptionGroup getGroup()

getType

public OptionValueType getType()

getUnits

public SaneOption.OptionUnits getUnits()

getSize

public int getSize()

getValueCount

public int getValueCount()

isConstrained

public boolean isConstrained()

Returns true if this option has a constraint other than OptionValueConstraintType.NO_CONSTRAINT.

getConstraintType

public OptionValueConstraintType getConstraintType()

getRangeConstraints

public RangeConstraint getRangeConstraints()

getStringConstraints

public java.util.List<java.lang.String> getStringConstraints()

getWordConstraints

public java.util.List<SaneWord> getWordConstraints()

getIntegerValueListConstraint

public java.util.List<java.lang.Integer> getIntegerValueListConstraint()

getFixedValueListConstraint

public java.util.List<java.lang.Double> getFixedValueListConstraint()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getBooleanValue

public boolean getBooleanValue()
                        throws java.io.IOException,
                               SaneException

Reads the current boolean value option. This option must be of type OptionValueType.BOOLEAN.

Throws:

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

SaneException

getIntegerValue

public int getIntegerValue()
                    throws java.io.IOException,
                           SaneException

Reads the current Integer value option. We do not cache value from previous get or set operations so each get involves a round trip to the server. TODO: consider caching the returned value for "fast read" later

Returns:

the value of the option

Throws:

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

SaneException

getIntegerArrayValue

public java.util.List<java.lang.Integer> getIntegerArrayValue()
                                                       throws java.io.IOException,
                                                              SaneException

Throws:

java.io.IOException

SaneException

getStringValue

public java.lang.String getStringValue()
                                throws java.io.IOException,
                                       SaneException

Returns the value of this option interpreted as a LATIN-1 (SANE's default encoding) encoded string.

Throws:

java.io.IOException - if a problem occurs reading the value from the SANE backend

SaneException

getStringValue

public java.lang.String getStringValue(java.nio.charset.Charset encoding)
                                throws java.io.IOException,
                                       SaneException

Throws:

java.io.IOException

SaneException

getFixedValue

public double getFixedValue()
                     throws java.io.IOException,
                            SaneException

Throws:

java.io.IOException

SaneException

getFixedArrayValue

public java.util.List<java.lang.Double> getFixedArrayValue()
                                                    throws java.io.IOException,
                                                           SaneException

Throws:

java.io.IOException

SaneException

setBooleanValue

public boolean setBooleanValue(boolean value)
                        throws java.io.IOException,
                               SaneException

Sets the value of the current option to the supplied boolean value. Option value must be of boolean type. SANE may ignore your preference, so if you need to ensure the value has been set correctly, you should examine the return value of this method.

Returns:

the value that the option now has according to SANE

Throws:

java.io.IOException

SaneException

setButtonValue

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

Throws:

java.io.IOException

SaneException

setFixedValue

public double setFixedValue(double value)
                     throws java.io.IOException,
                            SaneException

Sets the value of the current option to the supplied fixed-precision value. Option value must be of fixed-precision type.

Throws:

java.io.IOException

SaneException

setFixedValue

public java.util.List<java.lang.Double> setFixedValue(java.util.List<java.lang.Double> value)
                                               throws java.io.IOException,
                                                      SaneException

Sets the value of the current option to the supplied list of fixed-precision values. Option value must be of fixed-precision type and getValueCount() must be more than 1.

Throws:

java.io.IOException

SaneException

setStringValue

public java.lang.String setStringValue(java.lang.String newValue)
                                throws java.io.IOException,
                                       SaneException

Throws:

java.io.IOException

SaneException

setIntegerValue

public int setIntegerValue(int newValue)
                    throws java.io.IOException,
                           SaneException

Set the value of the current option to the supplied value. Option value must be of integer type TODO: consider caching the returned value for "fast read" later

Parameters:

newValue - for the option

Returns:

the value actually set

Throws:

java.io.IOException

SaneException

setIntegerValue

public java.util.List<java.lang.Integer> setIntegerValue(java.util.List<java.lang.Integer> newValue)
                                                  throws java.io.IOException,
                                                         SaneException

Throws:

java.io.IOException

SaneException

isActive

public boolean isActive()

isReadable

public boolean isReadable()

isWriteable

public boolean isWriteable()