org.geotools.image.io.text
Class TextImageWriter.Spi

java.lang.Object
  extended by javax.imageio.spi.IIOServiceProvider
      extended by javax.imageio.spi.ImageReaderWriterSpi
          extended by javax.imageio.spi.ImageWriterSpi
              extended by org.geotools.image.io.StreamImageWriter.Spi
                  extended by org.geotools.image.io.text.TextImageWriter.Spi
All Implemented Interfaces:
javax.imageio.spi.RegisterableService
Direct Known Subclasses:
TextMatrixImageWriter.Spi
Enclosing class:
TextImageWriter

public abstract static class TextImageWriter.Spi
extends StreamImageWriter.Spi

Service provider interface (SPI) for TextImageWriters. This SPI provides a convenient way to control the TextImageWriter character encoding: the charset field. For example, many Spi subclasses will put the following line in their constructor:

 charset = Charset.forName("ISO-LATIN-1"); // ISO Latin Alphabet No. 1 (ISO-8859-1)
 

Since:
2.4
Version:
$Id: TextImageWriter.java 30679 2008-06-13 10:19:41Z acuster $
Author:
Martin Desruisseaux (IRD)

Field Summary
protected  java.nio.charset.Charset charset
          Character encoding, or null for the default.
protected  java.lang.String lineSeparator
          The line separator to use, or null for the system default.
protected  java.util.Locale locale
          The locale for numbers formatting.
 
Fields inherited from class javax.imageio.spi.ImageWriterSpi
outputTypes, readerSpiNames, STANDARD_OUTPUT_TYPE
 
Fields inherited from class javax.imageio.spi.ImageReaderWriterSpi
extraImageMetadataFormatClassNames, extraImageMetadataFormatNames, extraStreamMetadataFormatClassNames, extraStreamMetadataFormatNames, MIMETypes, names, nativeImageMetadataFormatClassName, nativeImageMetadataFormatName, nativeStreamMetadataFormatClassName, nativeStreamMetadataFormatName, pluginClassName, suffixes, supportsStandardImageMetadataFormat, supportsStandardStreamMetadataFormat
 
Fields inherited from class javax.imageio.spi.IIOServiceProvider
vendorName, version
 
Constructor Summary
TextImageWriter.Spi()
          Constructs a quasi-blank TextImageWriter.Spi.
 
Method Summary
 
Methods inherited from class org.geotools.image.io.StreamImageWriter.Spi
canEncodeImage
 
Methods inherited from class javax.imageio.spi.ImageWriterSpi
canEncodeImage, createWriterInstance, createWriterInstance, getImageReaderSpiNames, getOutputTypes, isFormatLossless, isOwnWriter
 
Methods inherited from class javax.imageio.spi.ImageReaderWriterSpi
getExtraImageMetadataFormatNames, getExtraStreamMetadataFormatNames, getFileSuffixes, getFormatNames, getImageMetadataFormat, getMIMETypes, getNativeImageMetadataFormatName, getNativeStreamMetadataFormatName, getPluginClassName, getStreamMetadataFormat, isStandardImageMetadataFormatSupported, isStandardStreamMetadataFormatSupported
 
Methods inherited from class javax.imageio.spi.IIOServiceProvider
getDescription, getVendorName, getVersion, onDeregistration, onRegistration
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

charset

protected java.nio.charset.Charset charset
Character encoding, or null for the default. This field is initially null. A value shall be set by subclasses if the files to be encoded use some specific character encoding.

See Also:
TextImageWriter.getCharset(javax.imageio.ImageWriteParam)

locale

protected java.util.Locale locale
The locale for numbers formatting. For example Locale.US means that numbers are expected to use dot as decimal separator. This field is initially null, which means that default locale should be used.

See Also:
TextImageWriter.getDataLocale(javax.imageio.ImageWriteParam)

lineSeparator

protected java.lang.String lineSeparator
The line separator to use, or null for the system default.

See Also:
TextImageWriter.getLineSeparator(javax.imageio.ImageWriteParam)
Constructor Detail

TextImageWriter.Spi

public TextImageWriter.Spi()
Constructs a quasi-blank TextImageWriter.Spi. It is up to the subclass to initialize instance variables in order to provide working versions of all methods. This constructor provides the following defaults: For efficienty reasons, the above fields are initialized to shared arrays. Subclasses can assign new arrays, but should not modify the default array content.



Copyright © 1996-2010 Geotools. All Rights Reserved.