au.com.southsky.jfreesane

Class SaneWord

java.lang.Object

au.com.southsky.jfreesane.SaneWord

public final class SaneWord
extends java.lang.Object

Represents a SANE word type. JFreeSane chooses to represent the SANE word type as an array of SIZE_IN_BYTES bytes.

See the SANE specification for a thorough discussion about the SANE word type.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIZE_IN_BYTES The number of bytes used to represent a SANE word.
static com.google.common.base.Function<SaneWord,java.lang.Double>	TO_FIXED_FUNCTION A function that, when applied to a SaneWord instance, returns the SANE fixed precision value of that SANE word.
static com.google.common.base.Function<SaneWord,java.lang.Integer>	TO_INTEGER_FUNCTION A function that, when applied to a SaneWord instance, returns the integer value of that SANE word.

Method Summary

Modifier and Type	Method and Description
double	fixedPrecisionValue() Returns the value of this SaneWord treated as a SANE fixed precision value.
static SaneWord	forFixedPrecision(double value) Creates a new SaneWord from the given double.
static SaneWord	forInt(int value) Returns a new SaneWord representing the given integer value.
static SaneWord	forSaneVersion(int major, int minor, int build) Returns a new SaneWord representing the given SANE version.
static SaneWord	fromBytes(byte[] byteValue) Creates a new SaneWord from a copy of the given byte array.
static SaneWord	fromBytes(byte[] byteValue, int offset) Creates a new SaneWord from a copy of the given bytes within the array.
static SaneWord	fromStream(java.io.InputStream input) Returns a new SaneWord by consuming SIZE_IN_BYTES bytes from the given InputStream.
byte[]	getValue() Returns a copy of the underlying byte array representing this SaneWord.
int	integerValue() Treats this SaneWord as an integer and returns the represented value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SIZE_IN_BYTES

public static final int SIZE_IN_BYTES

The number of bytes used to represent a SANE word.

See Also:

Constant Field Values

TO_INTEGER_FUNCTION

public static final com.google.common.base.Function<SaneWord,java.lang.Integer> TO_INTEGER_FUNCTION

A function that, when applied to a SaneWord instance, returns the integer value of that SANE word.

See Also:

integerValue()

TO_FIXED_FUNCTION

public static final com.google.common.base.Function<SaneWord,java.lang.Double> TO_FIXED_FUNCTION

A function that, when applied to a SaneWord instance, returns the SANE fixed precision value of that SANE word.

See Also:

fixedPrecisionValue()

Method Detail

fromStream

public static SaneWord fromStream(java.io.InputStream input)
                           throws java.io.IOException

Returns a new SaneWord by consuming SIZE_IN_BYTES bytes from the given InputStream.

Throws:

java.io.IOException

forInt

public static SaneWord forInt(int value)

Returns a new SaneWord representing the given integer value.

forSaneVersion

public static SaneWord forSaneVersion(int major,
                                      int minor,
                                      int build)

Returns a new SaneWord representing the given SANE version.

Parameters:

major - the SANE major version

minor - the SANE minor version

build - the SANE build identifier

getValue

public byte[] getValue()

Returns a copy of the underlying byte array representing this SaneWord. The length of the array is SIZE_IN_BYTES bytes.

integerValue

public int integerValue()

Treats this SaneWord as an integer and returns the represented value.

fixedPrecisionValue

public double fixedPrecisionValue()

Returns the value of this SaneWord treated as a SANE fixed precision value.

fromBytes

public static SaneWord fromBytes(byte[] byteValue)

Creates a new SaneWord from a copy of the given byte array. The array must be of length SIZE_IN_BYTES, anything else will cause a runtime exception to be thrown.

fromBytes

public static SaneWord fromBytes(byte[] byteValue,
                                 int offset)

Creates a new SaneWord from a copy of the given bytes within the array. offset + SIZE_IN_BYTES must be a valid index (i.e. there must be enough bytes in the array at the given offset), otherwise a runtime exception is thrown.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

forFixedPrecision

public static SaneWord forFixedPrecision(double value)

Creates a new SaneWord from the given double. If value cannot be exactly represented in SANE's fixed precision scheme, then SaneWord.forFixedPrecision(someValue).fixedPrecisionValue() will not necessarily yield someValue.