org.beyka.tiffbitmapfactory

Class TiffConverter.ConverterOptions

java.lang.Object

org.beyka.tiffbitmapfactory.TiffConverter.ConverterOptions

Enclosing class:

TiffConverter

public static final class TiffConverter.ConverterOptions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
boolean	appendTiff For converting from ANY to TIFF cases If this value set to true while converting any to tiff - new tiff directory will be created and added to existed tiff file.
long	availableMemory Number of bytes that may be allocated during the file operations.
CompressionScheme	compressionScheme For converting from ANY to TIFF cases Compression scheme used on the image data.
java.lang.String	imageDescription For converting from ANY to TIFF cases A string that describes the subject of the image.
DecodeArea	inTiffDecodeArea If this field is non-null - Converter will use only area specified in DecodeArea object to convert.
int	readTiffDirectory For converting from TIFF to ANY cases Tiff directory that should be converted
ResolutionUnit	resUnit For converting from ANY to TIFF cases The unit of measurement for XResolution and YResolution.
java.lang.String	software For converting from ANY to TIFF cases Software that used for creating of image.
boolean	throwExceptions If set to true, converter will throw exceptions if some errors appeared while converting.
float	xResolution For converting from ANY to TIFF cases The number of pixels per resUnit in the ImageWidth direction.
float	yResolution For converting from ANY to TIFF cases The number of pixels per resUnit in the ImageHeight direction.

Constructor Summary

Constructors

Constructor and Description
ConverterOptions()

Method Summary

Modifier and Type	Method and Description
void	stop() Deprecated. As of release 0.9.8.4, replaced by Thread.interrupt()

Methods inherited from class java.lang.Object

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

Field Detail

availableMemory

public long availableMemory

Number of bytes that may be allocated during the file operations.

-1 means memory is unlimited.

Default value is 244Mb

throwExceptions

public boolean throwExceptions

If set to true, converter will throw exceptions if some errors appeared while converting. Otherwise converter will just return false. Default value is false

readTiffDirectory

public int readTiffDirectory

For converting from TIFF to ANY cases

Tiff directory that should be converted

appendTiff

public boolean appendTiff

For converting from ANY to TIFF cases

If this value set to true while converting any to tiff - new tiff directory will be created and added to existed tiff file.

Otherwise file will be overwritten.

Default value is false

compressionScheme

public CompressionScheme compressionScheme

For converting from ANY to TIFF cases Compression scheme used on the image data.

Default value is COMPRESSION_NONE

This parameter is link to TIFFTAG_COMPRESSION tag

inTiffDecodeArea

public DecodeArea inTiffDecodeArea

If this field is non-null - Converter will use only area specified in DecodeArea object to convert.

This field works only when convert from TIFF.

For decoding not full bitmap, but only part of it - create new DecodeArea object and specify:

x, y - left top corner of decoding area

width - width of decoding area

height - height of decoding area

xResolution

public float xResolution

For converting from ANY to TIFF cases The number of pixels per resUnit in the ImageWidth direction.

It is not mandatory that the image be actually displayed or printed at the size implied by this parameter. It is up to the application to use this information as it wishes.

Defualt value is 0

yResolution

public float yResolution

For converting from ANY to TIFF cases The number of pixels per resUnit in the ImageHeight direction.

It is not mandatory that the image be actually displayed or printed at the size implied by this parameter. It is up to the application to use this information as it wishes.

Defualt value is 0

resUnit

public ResolutionUnit resUnit

For converting from ANY to TIFF cases The unit of measurement for XResolution and YResolution.

To be used with xResolution and yResolution.

The specification defines these values:

• RESUNIT_NONE
• RESUNIT_INCH
• RESUNIT_CENTIMETER

Default value is ResolutionUnit.NONE

imageDescription

public java.lang.String imageDescription

For converting from ANY to TIFF cases A string that describes the subject of the image.

This parameter is link to TIFFTAG_IMAGEDESCRIPTION tag

software

public java.lang.String software

For converting from ANY to TIFF cases Software that used for creating of image.

This parameter is link to TIFFTAG_SOFTWARE tag

Constructor Detail

ConverterOptions

public ConverterOptions()

Method Detail

stop

public void stop()

Deprecated. As of release 0.9.8.4, replaced by Thread.interrupt()

Stop native convert thread If converting is started in any thread except main, calling of this method will cause force stop of converting and returning of false.