public class PsdImageParser extends ImageParser implements XmpEmbeddable
Modifier and Type | Field and Description |
---|---|
static String |
BLOCK_NAME_XMP |
static int |
IMAGE_RESOURCE_ID_ICC_PROFILE |
static int |
IMAGE_RESOURCE_ID_XMP |
Constructor and Description |
---|
PsdImageParser() |
Modifier and Type | Method and Description |
---|---|
boolean |
dumpImageFile(PrintWriter pw,
ByteSource byteSource)
Write the ImageInfo and format-specific information for the image
content of the specified byte source to a PrintWriter
|
protected String[] |
getAcceptedExtensions()
Get an array of all accepted extensions
|
protected ImageFormat[] |
getAcceptedTypes()
Get an array of ImageFormat objects describing all accepted types
|
BufferedImage |
getBufferedImage(ByteSource byteSource,
Map<String,Object> params)
Gets a buffered image specified by the byte source (for
sources that specify multiple images, choice of which image
is returned is implementation dependent).
|
String |
getDefaultExtension()
Get the default extension for the format specified by an implementation
of ImageParser.
|
byte[] |
getICCProfileBytes(ByteSource byteSource,
Map<String,Object> params)
Get an array of bytes describing the International Color Consortium (ICC)
specification for the color space of the image contained in the
input byteSource.
|
ImageInfo |
getImageInfo(ByteSource byteSource,
Map<String,Object> params)
Get image information from the specified ByteSource.
|
Dimension |
getImageSize(ByteSource byteSource,
Map<String,Object> params)
Get the size of the image described by the specified ByteSource.
|
ImageMetadata |
getMetadata(ByteSource byteSource,
Map<String,Object> params)
Get image metadata from the specified byte source.
|
String |
getName()
Get a descriptive name for the implementation of an ImageParser.
|
String |
getXmpXml(ByteSource byteSource,
Map<String,Object> params)
Extracts embedded XML metadata as XML string.
|
canAcceptExtension, canAcceptExtension, canAcceptType, dumpImageFile, dumpImageFile, dumpImageFile, getAllBufferedImages, getAllBufferedImages, getAllBufferedImages, getAllImageParsers, getBufferedImage, getBufferedImage, getBufferedImageFactory, getFormatCompliance, getFormatCompliance, getFormatCompliance, getICCProfileBytes, getICCProfileBytes, getICCProfileBytes, getICCProfileBytes, getImageInfo, getImageInfo, getImageInfo, getImageSize, getImageSize, getImageSize, getImageSize, getMetadata, getMetadata, getMetadata, getMetadata, getMetadata, isStrict, writeImage
debugNumber, debugNumber, getByteOrder, setByteOrder
public static final int IMAGE_RESOURCE_ID_ICC_PROFILE
public static final int IMAGE_RESOURCE_ID_XMP
public static final String BLOCK_NAME_XMP
public String getName()
ImageParser
getName
in class ImageParser
public String getDefaultExtension()
ImageParser
getDefaultExtension
in class ImageParser
protected String[] getAcceptedExtensions()
ImageParser
getAcceptedExtensions
in class ImageParser
protected ImageFormat[] getAcceptedTypes()
ImageParser
getAcceptedTypes
in class ImageParser
public byte[] getICCProfileBytes(ByteSource byteSource, Map<String,Object> params) throws ImageReadException, IOException
ImageParser
getICCProfileBytes
in class ImageParser
byteSource
- A valid ByteSource.params
- Optional instructions for special-handling or
interpretation of the input data.ImageReadException
- In the event that the specified content
does not conform to the format of the specific
parser implementation.IOException
- In the event of unsuccessful read or access operation.public Dimension getImageSize(ByteSource byteSource, Map<String,Object> params) throws ImageReadException, IOException
ImageParser
getImageSize
in class ImageParser
byteSource
- A valid reference to a ByteSource.params
- Optional instructions for special-handling or
interpretation of the input data.ImageReadException
- In the event that the specified content
does not conform to the format of the specific
parser implementation.IOException
- In the event of unsuccessful read or access operation.public ImageMetadata getMetadata(ByteSource byteSource, Map<String,Object> params) throws ImageReadException, IOException
ImageParser
The params argument provides a mechanism for individual implementations to pass optional information into the parser. Not all formats will require this capability. Because the base class may call this method with a null params argument, implementations should always include logic for ignoring null input.
getMetadata
in class ImageParser
byteSource
- A valid byte source.params
- Optional instructions for special-handling or
interpretation of the input data (null objects are permitted and
must be supported by implementations).ImageReadException
- In the event that the ByteSource
content does not conform to the format of the specific parser
implementation.IOException
- In the event of unsuccessful data read operation.public ImageInfo getImageInfo(ByteSource byteSource, Map<String,Object> params) throws ImageReadException, IOException
ImageParser
The params argument provides a mechanism for individual implementations to pass optional information into the parser. Not all formats will require this capability. Because the base class may call this method with a null params argument, implementations should always include logic for ignoring null input.
getImageInfo
in class ImageParser
byteSource
- A valid ByteSource objectparams
- Optional instructions for special-handling or interpretation
of the input data (null objects are permitted and
must be supported by implementations).ImageReadException
- In the event that the specified content
does not conform to the format of the specific
parser implementation.IOException
- In the event of unsuccessful data access operation.public boolean dumpImageFile(PrintWriter pw, ByteSource byteSource) throws ImageReadException, IOException
ImageParser
dumpImageFile
in class ImageParser
pw
- print writer used for writing the ImageInfobyteSource
- A valid byte source.ImageReadException
- In the event that the specified content
does not conform to the format of the specific
parser implementation.IOException
- In the event of unsuccessful read or access operation.public BufferedImage getBufferedImage(ByteSource byteSource, Map<String,Object> params) throws ImageReadException, IOException
ImageParser
getBufferedImage
in class ImageParser
byteSource
- A valid instance of ByteSourceparams
- Optional instructions for special-handling or
interpretation of the input data (null objects are permitted and
must be supported by implementations).ImageReadException
- In the event that the specified content
does not conform to the format of the specific
parser implementation.IOException
- In the event of unsuccessful read or access operation.public String getXmpXml(ByteSource byteSource, Map<String,Object> params) throws ImageReadException, IOException
getXmpXml
in interface XmpEmbeddable
byteSource
- File containing image data.params
- Map of optional parameters, defined in ImagingConstants.ImageReadException
- In the event that the specified content
does not conform to the format of the specific
parser implementation.IOException
- In the event of unsuccessful read or access operation.Copyright © 2007–2020 The Apache Software Foundation. All rights reserved.