Package org.apache.tika.parser.image

Class ICOParser

java.lang.Object

org.apache.tika.parser.image.ICOParser

All Implemented Interfaces:

Serializable, SelfConfiguring, Parser

public class ICOParser
extends Object
implements Parser

Parser for Windows icon (ICO) and cursor (CUR) files. Reads the ICONDIR and the header of every image to report the dimensions and colour depth of the largest image, the list of all images and, for cursors, the hotspot. The images themselves are not decoded.

The directory's own width, height and colour fields are unreliable (256 px is stored as 0, many tools leave the bit count empty), so the values come from each image's PNG IHDR or BITMAPINFOHEADER and the directory is only the fallback. Colour depth is reported the TIFF way, bits per sample and samples per pixel; the per-image list carries the total bits per pixel.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ICOParser()

Method Summary

Modifier and Type	Method	Description
Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this parser when used with the given parse context.
void	parse(TikaInputStream tis, ContentHandler handler, Metadata metadata, ParseContext context)	Parses a document stream into a sequence of XHTML SAX events.

Methods inherited from class java.lang.Object

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

Constructor Details

ICOParser

public ICOParser()

Method Details

getSupportedTypes

public Set<MediaType> getSupportedTypes(ParseContext context)

Description copied from interface: Parser

Returns the set of media types supported by this parser when used with the given parse context.

Specified by:

getSupportedTypes in interface Parser

Parameters:

context - parse context

Returns:

immutable set of media types

parse

public void parse(TikaInputStream tis,
 ContentHandler handler,
 Metadata metadata,
 ParseContext context)
           throws IOException,
SAXException,
TikaException

Description copied from interface: Parser

Parses a document stream into a sequence of XHTML SAX events. Fills in related document metadata in the given metadata object.

The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

Information about the parsing context can be passed in the context parameter. See the parser implementations for the kinds of context information they expect.

Specified by:

parse in interface Parser

Parameters:

handler - handler for the XHTML SAX events (output)

metadata - document metadata (input and output)

context - parse context

Throws:

IOException - if the document stream could not be read

SAXException - if the SAX events could not be processed

TikaException - if the document could not be parsed