Package org.apache.commons.imaging

Class ImagingParameters<E extends ImagingParameters<E>>

java.lang.Object

org.apache.commons.imaging.ImagingParameters<E>

Type Parameters:

E - This type

Direct Known Subclasses:

BmpImagingParameters, IcnsImagingParameters, IcoImagingParameters, PcxImagingParameters, PnmImagingParameters, PsdImagingParameters, RgbeImagingParameters, WbmpImagingParameters, XbmImagingParameters, XmpImagingParameters, XpmImagingParameters

public class ImagingParameters<E extends ImagingParameters<E>>
extends java.lang.Object

Imaging parameters.

Contains parameters that are common to all formats. Implementations must include the specific parameters for each image format.

Since:

1.0-alpha3

Field Summary

Fields

Modifier and Type	Field	Description
private BufferedImageFactory	bufferedImageFactory	Creates BufferedImages.
private java.lang.String	fileName	An optional file name, used for the description of input streams where a file name would be hard (or not possible) to be identified.
private PixelDensity	pixelDensity	Parameter key.
private boolean	strict	Whether to throw an exception when any issue occurs during reading or writing a file format.

Constructor Summary

Constructors

Constructor	Description
ImagingParameters()

Method Summary

Modifier and Type	Method	Description
E	asThis()	Returns this instance typed as the subclass type E.
BufferedImageFactory	getBufferedImageFactory()
java.lang.String	getFileName()
PixelDensity	getPixelDensity()
boolean	isStrict()
E	setBufferedImageFactory(BufferedImageFactory bufferedImageFactory)
E	setFileName(java.lang.String fileName)
E	setPixelDensity(PixelDensity pixelDensity)
E	setStrict(boolean strict)

Methods inherited from class java.lang.Object

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

Field Detail

strict

private boolean strict

Whether to throw an exception when any issue occurs during reading or writing a file format. Default is false.

fileName

private java.lang.String fileName

An optional file name, used for the description of input streams where a file name would be hard (or not possible) to be identified. Default is null.

bufferedImageFactory

private BufferedImageFactory bufferedImageFactory

Creates BufferedImages. Default is null.

pixelDensity

private PixelDensity pixelDensity

Parameter key. Used in write operations to indicate the desired pixel density (DPI), and/or aspect ratio.

Constructor Detail

ImagingParameters

public ImagingParameters()

Method Detail

asThis

public E asThis()

Returns this instance typed as the subclass type E.

This is the same as the expression:

 (B) this
 

Returns:

this instance typed as the subclass type E.

getBufferedImageFactory

public BufferedImageFactory getBufferedImageFactory()

getFileName

public java.lang.String getFileName()

getPixelDensity

public PixelDensity getPixelDensity()

isStrict

public boolean isStrict()

setBufferedImageFactory

public E setBufferedImageFactory(BufferedImageFactory bufferedImageFactory)

setFileName

public E setFileName(java.lang.String fileName)

setPixelDensity

public E setPixelDensity(PixelDensity pixelDensity)

setStrict

public E setStrict(boolean strict)