Package ca.cgjennings.imageio
Interface WritableImageFormat
-
public interface WritableImageFormat
This interface describes an image format that can be used to write an image to a file.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SimpleImageWriter
createImageWriter()
Creates a simple image writer that can be used to write images in this format.java.lang.String
getDescription()
A description of the trade-offs of using the format.java.lang.String
getExtension()
Returns the file extension for the format, e.g., jpg.java.lang.String
getFullName()
A full name for the format.java.lang.String
getName()
Returns a short name for the format, similar to what might be found in a file chooser, e.g., JPEG (*.jpg).
-
-
-
Method Detail
-
getName
java.lang.String getName()
Returns a short name for the format, similar to what might be found in a file chooser, e.g., JPEG (*.jpg).- Returns:
- short format name
-
getFullName
java.lang.String getFullName()
A full name for the format. May benull
.- Returns:
- the long name of the format
-
getDescription
java.lang.String getDescription()
A description of the trade-offs of using the format. May benull
.- Returns:
- the description of the format
-
getExtension
java.lang.String getExtension()
Returns the file extension for the format, e.g., jpg.- Returns:
- the file extension to use for images
-
createImageWriter
SimpleImageWriter createImageWriter()
Creates a simple image writer that can be used to write images in this format. The image writer must bedispose()
d of after use.- Returns:
- a new image writer for the format
-
-